Realizar login na API vai te permitir obter os dados de acesso da conta, incluindo o Token de acesso que deve ser utilizado nas requisições que exigem autenticação.
Requisição
Você deve utilizar uma requisição do tipo POST.
Exemplo:
https://api-sandbox.oxpay.com.br/login/document
No corpo da requisição você deve informar os seguintes valores:
- Document
Trata-se do documento cadastrado para essa conta. - Password
Deve-se informar a senha de acesso para essa conta. - Token
É composto por um código de segurança de 6 dígitos, gerado a cada 30 segundos por aplicativos de OTP, como o Google Authenticator, entre outros.
Código de segurança OTP
Para obter mais informações sobre como gerar o código de segurança OTP acesse aqui
Exemplo do corpo da requisição:
{
"Document":"61646949000158",
"Password":"945396",
"Token": "321654"
}
Resposta
{
"user": {
"customer_id": 0,
"company_id": 0,
"additional_company_ids": [
0
],
"firstname": "Nome",
"lastname": "Sobrenome",
"email": "[email protected]",
"telephone": "11912345678",
"document": "01234567890",
"data_admissao": "2024-01-01T09:28:50",
"newsletter": false,
"signed_term": true,
"profile": 1,
"onboarding_status": 3,
"onboarding_required": false
},
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bmlxdWVfbmFtZSI6Ik5vbWUgY29tcGxldG8iLCJlbWFpbCI6ImV4ZW1wbG9AZW1haWwuY29tIiwiQ3VzdG9tZXJJZCI6IjAiLCJDdXN0b21lckRvY3VtZW50IjoiMDEyMzQ1Njc4OTEiLCJDb21wYW55SWQiOiIwIiwiQ2FwYWJpbGl0aWVzIjoiIiwiQWRkaXRpb25hbENvbXBhbnlJZCI6IjAiLCJDYXBhYmlsaXRpZXNfMCI6Ii8vMS8xL1AvLy8vM2Z3PT0iLCJuYmYiOjE3Mjk3MDExMzAsImV4cCI6MTcyOTcwNDczMCwiaWF0IjoxNzI5NzAxMTMwfQ.oCiyDnRLolRlAmcoRaff9ToTTmeg7AeRtP2tWrEoT_w",
"expires_in": 3600
}