API - GoCache

Aqui você encontrará referências sobre como integrar o seu sistema com a nossa infraestrutura.

Apresentação

Nossa API é RESTful e todas as respostas são em JSON. As requisições devem ser feitas no endpoint:

https://api.gocache.com.br/v1

Autenticação

Associamos as chamadas na API à conta de referência, através de token enviado no header GoCache-Token.

Para obtê-lo, acesse o Painel de Controle em "Minha Conta" na aba "Conta". Em um primeiro momento, este acesso está disponível somente para clientes GoCache. Se você está em período trial e quer utilizar a API, entre em contato conosco através do email suporte@gocache.com.br.

Sucesso x Erro

A API da GoCache utiliza os códigos de status HTTP para indicar sucesso ou falha da chamada.

Código	Descrição
200	Sucesso
202	A requisição foi aceita e será processada
400	Bad Request - Parâmetro faltando ou com conteúdo inválido
401	Unauthorized - Token da API não especificado
403	Forbidden - O token especificado não tem acesso ao recurso
404	Not found - O item requisitado não existe
409	Conflict - O item informado já existe
50X	Algo está errado na GoCache

De uma forma geral, as chamadas feitas podem ter como retorno os campos msg, error e o objeto response. Abaixo alguns exemplos.

Sucesso - Exemplo 1

HTTP/1.1 200 OK
{
    "response": {
        "email": "teste@teste.com.br",
        "token": "xxxxxxxxxxxxxxxxxx"
    }
}

Sucesso - Exemplo 2

HTTP/1.1 200 OK
{
    "msg": "Success"
}

Erro - Exemplo 1

HTTP/1.1 400 Bad Request
{
    "error": "Parameter email is required"
}

Erro - Exemplo 2

HTTP/1.1 400 Bad Request
{
    "response": {
        "urls_wrong_format": [
            "/imagem.jpg"
        ]
    }
}

Abuso de Uso

Em casos de abuso de uso dos recursos da API da GoCache, o indivíduo acessante estará sujeito a ficar bloqueado de realizar qualquer requisição à API sem aviso prévio. É considerado abuso:

• Realizar mais que 100 requisições em 1 minuto;
• Enviar payloads maliciosos com intuito de obter dados ou realizar ações não permitidas para a conta;
• Se apresentar como proprietário da API.