Steps
- Run
npm install. - Copy file
env.templateto.env.development. - Run
docker-compose up --build.
Run docker-compose up for a dev server. Navigate to http://localhost:8000/.
The API will automatically reload if you change any of the source files.
app/
|
|– Configs
|
|– Configs
| |– environment.js
| |– Database
| | - config.js
| |– Application
| | - config.js
|
|- public/
| |– documentation/
| | |– api
| | |– server
|
|– src
| |- Http
| | |- Middlewares
| | | |-Auth
| | | - AuthMiddlewares.js
| | |- Routes
| | | |- routes.js
| | |- Controllers
| | | |- Domain
| | | | |- Accounts
| | | | | - AccountsController.js
| |- Database
| | |- Models
| | | |- Accounts
| | | - AccountsModels.js
| | | |
| |- Repositories
| | |- Interfaces
| | | - IRepository.js
| | |- Domain
| | | |- Accounts
| | | | |- AccountsRepository.js
| |- Providers
| |- Library
| | |- Validations
| | |- Accounts
| | - ValidateDocuments.js
| |- Helpers
| Código | Nome | Descrição |
|---|---|---|
| 200 | OK | O recurso solicitado foi processado e retornado com sucesso. |
| 201 | Created | O recurso informado foi criado com sucesso. |
| 401 | Unauthorized | A chave da API está desativada, incorreta ou não foi informada corretamente. Consulte a seção sobre autenticação da documentação. |
| 402 | Payment Required | A chave da API está correta, porém a conta foi bloqueada por inadimplência. Neste caso, acesse o painel para verificar as pendências. |
| 403 | Forbidden | O acesso ao recurso não foi autorizado. Este erro por ocorrer por dois motivos: (1) Uma conexão sem criptografia foi iniciada. Neste caso utilize sempre HTTPS. (2) As configurações de perfil de acesso não permitem a ação desejada. Consulte as configurações de acesso no painel de administração. |
| 404 | Not Found | O recurso solicitado ou o endpoint não foi encontrado. |
| 406 | Not Acceptable | O formato enviado não é aceito. O cabeçalho Content-Type da requisição deve contar obrigatoriamente o valor application/json para requisições do tipo POST e PUT. |
| 422 | Unprocessable Entity | A requisição foi recebida com sucesso, porém contém parâmetros inválidos. Para mais detalhes, verifique o atributo errors no corpo da resposta. |
| 429 | Too Many Requests | O limite de requisições foi atingido. Verifique o cabeçalho Retry-After para obter o tempo de espera (em segundos) necessário para a retentativa. |
| 400 | Bad Request | Não foi possível interpretar a requisição. Verifique a sintaxe das informações enviadas. |
| 500 | Internal Server Error | Ocorreu uma falha na plataforma Vindi. Por favor, entre em contato com o atendimento. |
Nomes e códigos seguem a RFC 2616 do IETF.
Observações: Métodos usados para buscas (GET /customers, por exemplo) retornam o código 200 mesmo que nenhum recurso tenha sido encontrado. Neste caso, o corpo da resposta conterá um array vazio. Requisições do tipo DELETE e PUT retornam o código 200 se forem processadas com sucesso.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent