Teste de Conexão

Siga nosso passo a passo para realizar a sua primeira consulta em nossa API.

Antes de iniciar a integração, é necessário estar com suas chaves de API.

Como se autenticar?

Aqui, utilizaremos suas credenciais, que você deve ter em mãos neste momento.

Login

post

Body

application/json

objectOptionalExample: {"email":"[email protected]","password":"suasenha"}

Responses

200

successful

application/json

ResponseobjectExample: {"expires_in":1742573973,"access_token":"eyJhbGciOiJIUzI1NiIgInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InZlbmRhc3Jldml2ZUBnbWFpbC5jb20iLCJzdWIiOjExMjcsInR5cGUiOiJDTElFTlRFIiwidXVpZCI6MzYxLCJzdGF0dXMiOiJWRVJJRklDQURPIiwiaWF0IjoxNzQyNDg3NTczLCJleHAiOjE3NDI1NzM5NzN9.Eqi-IinSg6INraBz-DslMXvbYCd5zKXA888Rffj9GRQ","user":{"_id":0,"name":"Teste","document":"00011100011","email":"[email protected]","isFirstLogin":true,"companyId":0,"companyName":"TESTE","companyISPB":"","companyType":"CLIENTE","agencyNumber":"0001","accountNumber":"0000002","clientToken":"352db55b-298f-450c-g14e-e569880b6a7e"},"role":""}

401

authorization failed

application/json

404

Login not found

application/json

422

validation failed

500

unknown server error

post

/internal/api/v1/auth/login

HTTPcURLJavaScriptPython

POST /internal/api/v1/auth/login HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "email": "[email protected]",
  "password": "suasenha"
}

{
  "expires_in": 1742573973,
  "access_token": "eyJhbGciOiJIUzI1NiIgInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InZlbmRhc3Jldml2ZUBnbWFpbC5jb20iLCJzdWIiOjExMjcsInR5cGUiOiJDTElFTlRFIiwidXVpZCI6MzYxLCJzdGF0dXMiOiJWRVJJRklDQURPIiwiaWF0IjoxNzQyNDg3NTczLCJleHAiOjE3NDI1NzM5NzN9.Eqi-IinSg6INraBz-DslMXvbYCd5zKXA888Rffj9GRQ",
  "user": {
    "_id": 0,
    "name": "Teste",
    "document": "00011100011",
    "email": "[email protected]",
    "isFirstLogin": true,
    "companyId": 0,
    "companyName": "TESTE",
    "companyISPB": "",
    "companyType": "CLIENTE",
    "agencyNumber": "0001",
    "accountNumber": "0000002",
    "clientToken": "352db55b-298f-450c-g14e-e569880b6a7e"
  },
  "role": ""
}

Como testar sua conexão?

Para testar a conexão, você pode enviar uma solicitação GET para o seguinte endpoint: https://sandbox.globalscm.app.br/internal/api/v1/bank?page=6&limit=10

Bancos

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

successful

No content

401

authorization failed

422

validation failed

500

unknown server error

get

/internal/api/v1/bank

HTTPcURLJavaScriptPython

GET /internal/api/v1/bank HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

A seguir um diagrama de sequência, ilustrando como fazer um teste de conexão:

Não se esqueça de incluir o token de autenticação recebido no cabeçalho "Authorization" de todas as suas requisições.