​
Base URL

Todas as requisicoes devem ser feitas para: 
https://api.realoficial.com.br/api/v1

​
Headers Padrao

Todas as requisicoes devem incluir os seguintes headers:
HeaderValorObrigatorio
AuthorizationBearer {token}Sim (exceto login)
Content-Typeapplication/jsonSim para POST/PUT
Acceptapplication/jsonRecomendado

​
Formato de Resposta

Todas as respostas sao retornadas em JSON.

​
Resposta de Sucesso

{
  "message": "Operacao realizada com sucesso",
  "data": { ... }
}

​
Resposta de Erro

{
  "error": "Descricao do erro"
}

​
Codigos HTTP

CodigoDescricao
200Sucesso
201Criado com sucesso
202Aceito (processamento assincrono)
400Requisicao invalida
401Nao autenticado
403Sem permissao
404Nao encontrado
429Muitas requisicoes (rate limit)
500Erro interno do servidor

​
Paginacao

Endpoints que retornam listas utilizam paginacao: 
{
  "data": [...],
  "links": {
    "first": "https://api.realoficial.com.br/api/v1/projects?page=1",
    "last": "https://api.realoficial.com.br/api/v1/projects?page=10",
    "prev": null,
    "next": "https://api.realoficial.com.br/api/v1/projects?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 10,
    "per_page": 20,
    "to": 20,
    "total": 200
  }
}

​
Parametros de Paginacao

ParametroTipoDescricaoPadrao
pageintegerNumero da pagina1
per_pageintegerItens por pagina (max: 100)20

​
Endpoints Disponiveis

Autenticacao

  • POST /login
  • POST /social/callback/email
  • GET /user

Projetos

  • POST /projects
  • GET /projects
  • POST /createShorts

Shorts

  • GET /shorts/
  • GET /shorts//

Renders

  • POST /shorts///render
  • POST /renders/bulk
  • GET /renders