Primeiros passos

Nesta seção te auxiliaremos para que você consiga fazer seu primeiro request.

Ambientes

Na Shippify, fornecemos dois ambientes, um de produção e outro de testes. Ambos consistem em 2 contas diferentes, mas apontam para o mesmo endpoint, porém as credenciais são diferentes. Para criar suas contas, revisite este link.

Autenticação

Para acessar as entregas via API, utilizamos autenticação básica HTTP. Para chamar nossa API, você precisa usar suas credenciais que estão nas configurações da empresa. https://dash.shippify.co/settings/sections/profile

Credenciales

Você receberá um ID de APP e um APP SECRET do painel para construir seu token com autenticação básica. Em ferramentas como o Postman, você pode inserir diretamente suas credenciais e não é necessário construir o token manualmente.

Autenticación en postman

Para integrar por código, você precisará formar o token básico para adicionar aos cabeçalhos das solicitações com a chave Authorization. Isso é feito convertendo as credenciais (separadas por :) em base 64.

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

Header con basic token

O link para chamar os endpoints é:

https://api.shippify.co

Primeiro request

Para testar nossa API, basta ter as credenciais de autenticação. Para nosso primeiro pedido, vamos consumir um endpoint de países. Neste espaço, você pode testar o pedido com suas credenciais.

Países.

Obtiene la lista de países donde opera shippify.

GEThttps://api.shippify.co/v1/country

Authorization

Basic_Auth

Response

200401

Successful operation

Body

application/json

codestring

Example: "OK"

messagestring

Example: "Success"

payloadarray of Country (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.shippify.co/v1/country', {
    method: 'GET',
    headers: {
      "Authorization": "basic <token>"
    },
});
const data = await response.json();

Response

200401

{
  "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 da resposta da 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	Descrição
200 OK	A solicitação foi processada com sucesso pela Shippify.
400 Bad Request	O servidor Shippify não conseguiu decodificar o corpo da solicitação, geralmente devido a uma sintaxe mal formada ou a um cabeçalho incorreto.
401 Unauthorized	A pessoa que fez a chamada não estava autorizada a fazer a solicitação devido à falta de credenciais de autenticação ou porque eram incorretas. Consulte Autenticação para obter mais informações.
404 Not Found	Não é possível localizar o recurso solicitado. Consulte a API da Shippify para obter o nome correto dos endpoints.
412 Precondition Failed	Payload com formato icnorreto.
429 Too Many Requests	A solicitação superou a taxa limite de solicitações.
500 Internal Server Error	Ocorreu um erro interno no servidor da Shippify. Se o problema persistir, entre em contato com o Suporte.
503 Service Unavailable	O servidor Shippify não está disponível temporariamente. Se o problema persistir, entre em contato com o Suporte.
504 Gateway Timeout	O servidor Shippify, que atua como gateway ou proxy, excedeu o tempo limite ao tentar concluir a solicitação. Tente novamente mais tarde ou, se o problema persistir, entre em contato com o Suporte.

Restrições

Para a maioria dos nossos endpoints, temos configurados certos limites no momento de fazer uma solicitação, e é importante ter em mente ao integrar:

• Não é possível fazer mais de 100 solicitações por minuto para a API.

• Não é possível criar ou editar mais de 100 pedidos em uma solicitação.

Coleção no postman

Disponibilizamos nossa API pública em uma coleção no Postman com exemplos em cada requisição adicionada para que você possa realizar testes. Nesta coleção existem os dois ambientes. Uma vez clonada a coleção, você poderá inserir suas credenciais para poder utilizá-la.

Shippify Public APIPostman