Dúvida
Como funciona a solicitação da API de Integração do TOTVS CRM?
Ambiente
Cross Segmentos - TOTVS CRM Gestão de Clientes - API de Integração - Todas as versões.
Solução
Para realizar a requisição na API de integração com sucesso, é necessário entender alguns pontos sobre a solicitação:
1. Formato JSON
A API de Integração do TOTVS CRM Gestão de Clientes retorna dados em um formato leve denominado JSON.
1.2. Se você deseja enviar dados à API para atualizar ou criar dados, primeiro é necessário convertê-los para JSON.
1.3. Se você deseja obter dados, a API os entregará como JSON e você precisará convertê-los em algo que possa usar.
1.1.1 A aparência do formato JSON é a seguinte:
{
“name”: “Customer name”,
“birthday”: “15/02/1970”
}
2. Métodos
Para cada ação, podem ser utilizados os seguintes métodos:
2.1. GET: recuperar itens.
2.2. POST: criar itens que não existiam antes ou realizar atualizações.
2.3. DELETE: remover itens.
Observação: Em um navegador, somente é possível fazer solicitações GET. Você pode executar outras ações usando ferramentas como URL ou Postman.
3. Status das suas solicitações
Para cada solicitação de API que você fizer, receberá uma resposta informando se ela funcionou ou não. Em caso negativo, a resposta dará indicações de porque a solicitação não funcionou. Essas respostas são denominadas códigos de status.
Estas são algumas das respostas mais comuns:
- 200: A solicitação teve êxito
- 201: A solicitação foi criada com sucesso
- 400: Falha na solicitação
- 401: Sem autorização, realizar login novamente
- 409: Erro de fusão ou restrição, tente a requisição novamente
- 422: Entidade não processável
- 429: Limite de taxa excedido
- 500: Aviso ou status temporário, entre em contato com o suporte se persistir
- 503: Sem permissão de acesso
4. Para mais informações sobre outros recursos da API do TOTVS CRM, acesse a documentação da API no Git Lab.
Artigos relacionados:
0 Comentários