Tiempo estimado para lectura: 00:01:00 min
Duda
¿Cómo solicitar la API de Integración?
Ambiente
Cross Segmentos - TOTVS CRM Gestión de Clientes MI - API de Integración - Todas las versiones
Solución
Para realizar la requisición en API de integração con éxito, es necesario entender algunos puntos sobre la solicitud.
1. Formato JSON:
La API de Integración del TOTVS CRM retorna datos en un formato ligero denominado JSON:
- Si usted desea enviar datos a la API para actualizar o crear datos, primero es necesario convertirlos para JSON.
- Si usted desea obtener datos, la API te entregará como JSON y usted necesitará convertirlos en algo que pueda usar.
1.1. La apariencia del formato JSON:
{
“name”: “Customer name”,
“birthday”: “15/02/1970”
}
2. Métodos:
Para cada acción, pueden ser utilizados los siguientes métodos:
- GET: recuperar artículos;
- POST: crear artículos que antes no existían y realizar actualizaciones.
- DELETE: borrar artículos.
En un navegador, solamente es posible hacer solicitudes GET. Usted puede ejecutar otras acciones utilizando herramientas como cURL o Postman.
3. Estado de las solicitudes:
Para cada solicitud de API que usted haga, recibirás una respuesta informando si ella funciono o no. En caso negativo, la respuesta dará indicaciones de porque no funciono la solicitud. Esas respuestas son denominadas códigos de estado. Estas son algunas de las respuestas básicas:
- 200: la solicitud tuvo éxito
- 201: solicitud creada con éxito
- 400: solicitud fallida
- 401: sin autorización, realizar login nuevamente
- 409: error de fusión o restricción, inténtalo la requisición nuevamente
- 422: entidad no procesable
- 429: límite de tarifa excedido
- 500: aviso o estado temporário, si persiste entre en contacto con el soporte
- 503: sin permiso de acceso
4. Donde encontrar informaciones sobre la API de Integración del TOTVS CRM:
Para más informaciones sobre otros recursos de la API de TOTVS CRM, acceda a documentación de la API en Git Lab.
Sepa más
0 Comentarios