100Pay – Api – Documentação

Introdução

A API 100Pay está implementada em conformidade com o princípio de design REST. Nossa API possui recursos orientados a URLs, com códigos HTTP para indicar erros. Nós utilizamos funcionalidades HTTP nativas, como verbos de ação POST, GET, DELETE, para operações de leitura e escrita, bem como o modelo básico de autenticação HTTP.

Nós suportamos chamadas diretas aos recursos da API a partir de outras origens,CORS (cross-origin resource sharing), permitindo você interagir de maneira segura com nossas APIs a partir de aplicações web. Todas as respostas da API estão no formato de dados JSON, incluindo errors.

Autenticação Básica

Nossas APIs permitem autenticação utilizando Baerer Token. Você receberá as credencias de produção e teste, contento para cada ambiente. Além dessas credenciais, você também receberá os acessos ao dashboard de produção e teste.

Para autenticar, você utilizará a chave recebida como Baerer, você deverá adicionar um  header HTTP, exemplo:
Authorization: --

header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1aWQiOjEsImlhdCI6MTYwMDg2NDUzOH0.t9Vdx6YawjmGCXwUu_t1WpgQ_ykUzKW-9NauYlUUEFo'

Códigos de Erro

 

 

Códigos de Status HTTP

Em poucas palavras, existem apenas 3 resultados na interação entre seu aplicativo e nossa API:

  • Tudo funcionou
  • O aplicativo fez algo errado
  • A API fez algo errado
  • A API tenta retornar códigos de status de resposta HTTP apropriados para cada solicitação.



Em geral, os códigos no intervalo 2xx indicam sucesso, os códigos no intervalo 4xx indicam um erro resultante das informações fornecidas (por exemplo, um parâmetro necessário faltou, uma transação falhou, etc.) e os códigos no intervalo 5xx indicam um erro com os servidores.

A tabela a seguir contém os valores mais comuns para os códigos de status HTTP retornados pela API:

HTTP STATUS CODE Texto Descrição
200 OK Tudo funcionou conforme o esperado.
201 Created A requisição foi bem sucedida e um novo recurso foi criado.
304 Not Modified Não havia dados novos para retornar.
400 Bad Request A requisição foi invalida ou não atingiu o servidor. Muitas vezes, falta um parâmetro obrigatório.
401 Unauthorized As credenciais de autenticação estavam faltando ou foram incorretas.
402 Request Failed Os parâmetros foram válidos mas a requisição falhou.
403 Forbidden A requisição foi ok, mas foi recusado ou o acesso não foi permitido. Uma mensagem de erro que acompanha a mensagem explica o porquê.
404 Not Found A URI solicitada é inválida ou o recurso solicitado, como por exemplo, um vendedor não existe ou foi excluído.
500 Internal Server Error Algo está quebrado. Por favor, assegure-se de que a equipe Zoop esteja investigando.
502 Bad Gateway A Zoop caiu ou está sendo atualizada.

GET 

Listar Transações 

http://18.229.117.224:3333/api

 

AUTHORIZATION Bearer Token
Token <token>

 

Example RequestListar Transações

curl --location --request GET 'http://18.229.117.224:3333/api'

POST 

Cadastrar Transação 

http://18.229.117.224:3333/api
AUTHORIZATION Bearer Token
Token <token>
HEADERS  
authorization Bearer
content-type application/json

BODY raw

{    "payment_type": "1231cash",
    "amount": 300,
    "description": "xxxxx",
    "on_behalf_of": "4545222545254522255",
    "number_installments": 10,
    "subscriber": "feitosa",
    "dependent": "Castro",
    "taxpayer_id": "46882847304",
    "email": "[email protected]",
    "phone_number": "+5585989031145"  }

Example RequestCadastrar Transação

curl --location --request POST 'http://18.229.117.224:3333/api' \
--header 'content-type: application/json' \
--data-raw '{    "payment_type": "1231cash",
    "amount": 300,
    "description": "xxxxx",
    "on_behalf_of": "4545222545254522255",
    "number_installments": 10,
    "subscriber": "feitosa",
    "dependent": "Castro",
    "taxpayer_id": "46882847304",
    "email": "[email protected]",
    "phone_number": "+5585989031145"  }'

GET 

Listar Transação Específica 

http://18.229.117.224:3333/api/1
AUTHORIZATION Bearer Token
Token <token>
HEADERS  
authorization Bearer

Example Request Listar Transação Específica

curl --location --request GET 'http://18.229.117.224:3333/api/1'

DEL 

Deletar Transação Específica 

http://18.229.117.224:3333/api/1
AUTHORIZATION Bearer Token
Token <token>
HEADERS  
authorization Bearer

Example Request Deletar Transação Específica

curl --location --request DELETE 'http://18.229.117.224:3333/api/1'