Endpoint que lista todos os registros cadastrados.
Method | URI | Headers | Authorization |
---|---|---|---|
GET | /api/v3/integrations-accounts | Content-Type:application/json | Authorization: Bearer {token} |
Observações:Apenas o Super Admin que poderá listar todas as integrações que esteja ou não vinculado a conta do mesmo, caso contrário será listado apenas as integrações vinculadas na conta do usuário.
Response 200 (application/json)
Response 204 (application/json).Quando os critérios de parâmetros não contiver registros a serem retornados.
Response 422 (application/json)
Response 403 (application/json)"Permissões insuficientes!"
Endpoint que pega um registro específico.
Method | URI | Headers | Authorization |
---|---|---|---|
GET | /api/v3/integrations-accounts/1 | Content-Type: application/json | Authorization: Bearer {token} |
Response 200 (application/json)
Response 204 (application/json)Quando o registro não existir.
Response 403 (application/json)"Permissões insuficientes!"
Endpoint que cria um registro.
Method | URI | Headers | Authorization |
---|---|---|---|
POST | /api/v3/integrations-accounts | Content-Type: application/json | Authorization: Bearer {token} |
Observações:Campo
account_id
só poderá ser informada apenas pelo Super Admin.Campo
token
é requerido quando não existir ousername
epassword
.Campo
username
epassword
são requeridos quando não existir otoken
.Campo
username
epassword
são requeridos quando não existir otoken
.Campo
frequency
terá que mandar o ID da frequência listada no endpoint Frenquências.
Response 201 (application/json)
Response 422 (application/json)
Response 403 (application/json)"Permissões insuficientes!"
Endpoint que atualiza um registro específico.
Method | URI | Headers | Authorization |
---|---|---|---|
PUT | /api/v3/integrations-accounts/1 | Content-Type: application/json | Authorization: Bearer {token} |
Observações:Campo
token
é requerido quando não existir ousername
epassword
.Campo
username
epassword
são requeridos quando não existir otoken
.Campo
username
epassword
são requeridos quando não existir otoken
.Campo
frequency
terá que mandar o ID da frequência listada no endpoint Frenquências.
Response 200 (application/json)
Response 422 (application/json)
Response 403 (application/json)"Permissões insuficientes!"
Endpoint que deleta um registro específico.
Method | URI | Headers | Authorization |
---|---|---|---|
DELETE | /api/v3/integrations-accounts/1 | Content-Type: application/json | Authorization: Bearer {token} |
Response 200 (application/json)
Response 400 (application/json)"Algo inesperado ocorreu."
Response 403 (application/json)"Permissões insuficientes!"