Primeros pasos

En esta sección te guiaremos para que consigas realizar tu primer request.

Ambientes

En Shippify proporcionamos dos ambientes, uno productivo y otro de pruebas, estos consisten en 2 cuentas diferentes, ambos apuntan al mismo endpoint pero las credenciales cambian. Para crear tus cuentas revisa este sitio.

Autenticación

El acceso a las entregas vía API se basa en la autenticación básica HTTP. Para poder llamar a nuestra API debes utilizar tus credenciales que se encuentran en la configuración de la empresa https://dash.shippify.co/settings/sections/profile

Credenciales

Obtendrás un ID de APP y un APP SECRET del dash para poder construir tu token con basic auth. En herramientas como postman, puedes colocar directamente tus credenciales y no es necesario armar el token.

Autenticación en postman

Sin embargo para integrar por código vas a necesitar formar el basic token para agregarlo en los headers de los requests bajo el key Authorization. Esto se realiza transformando las credenciales (seraradas por :) a base 64.

const apiId="XXXXXXXX";
const apiToken="XXXXXXXXXX";
const token = `Basic ${btoa(`${apiId}:${apiToken}`)}`;

Header con basic token

El dominio para llamar a los endpoints es:

https://api.shippify.co

Primer request

Para probar nuestra API basta con tener las credenciales de autenticación, para nuestro primer request vamos a consumir un endpoint de paises, en este espacio podrás probar el request y tus credenciales.

Países.

get

Obtiene la lista de países donde opera shippify.

Autorizaciones

Basic_Auth

AuthorizationstringRequerido

Respuestas

200

Successful operation

application/json

codestringOpcionalExample: OK

messagestringOpcionalExample: Success

401

Unauthorized

application/json

get

/v1/country

HTTPcURLJavaScriptPython

GET /v1/country HTTP/1.1
Host: api.shippify.co
Authorization: Basic username:password
Accept: */*

{
  "code": "OK",
  "message": "Success",
  "payload": [
    {
      "id": 1,
      "name": "BRASIL",
      "countryCode": "BR",
      "isSaasVisible": 1,
      "defaultCityId": 1,
      "defaultCityName": "Belo Horizonte",
      "created_at": "2022-10-14T15:01:23.000Z"
    }
  ]
}

Códigos de estado de respuesta API

Cada interacción con la API de Shippify devuelve un código de estado HTTP que indica si la solicitud tuvo éxito, falló o exige acciones particulares para acciones posteriores.

Código de estado	Descripción
200 OK	La solicitud fue procesada exitosamente por Shippify.
400 Bad Request	El servidor Shippify no pudo decodificar el cuerpo de la solicitud, generalmente debido a una sintaxis mal formada o un encabezado incorrecto.
401 Unauthorized	La persona que llama no estaba autorizada para realizar la solicitud debido a que faltaban credenciales de autenticación o eran incorrectas. Consulte Autenticación para obtener más información.
404 Not Found	No se puede localizar el recurso solicitado. Consulte la API de Shippify para conocer el nombre correcto de los endpoints.
412 Precondition Failed	Payload con un formato incorrecto.
429 Too Many Requests	La solicitud superó los límites de tasa de solicitud.
500 Internal Server Error	Ocurrió un error interno del servidor de Shippify. Si el problema persiste, comuníquese con Soporte.
503 Service Unavailable	El servidor Shippify no está disponible temporalmente. Si el problema persiste, comuníquese con Soporte.
504 Gateway Timeout	El servidor Shippify que actúa como gateway o proxy agotó el tiempo de espera al intentar completar la solicitud. Inténtelo nuevamente más tarde o, si el problema persiste, comuníquese con Soporte .

Restricciones

Para la mayoría de nuestros endpoints tenemos configurado ciertos límites al momento de hacer un request y es importante tener en cuenta al momento de integrar:

• No se puede realizar mas de 100 request por minuto al API.

• No se puede mandar a crear o editar mas de 100 pedidos en un request.

Colección en postman

Ponemos a tu disposición nuestra API pública en una colección en postman con los ejemplos en cada request agregado para que puedas realizar pruebas. En esta colección existiran los dos ambientes, una vez clonada la colección podrás ingresar tus credenciales para poder utilizarla.

Postmanwww.postman.com