Documentação da API
Projetos
Organize seus recursos dentro de projetos.
Autenticação
Cada requisição deve enviar o cabeçalho Authorization com um token Bearer correspondente à chave API admin.
Obter chave da API.
Ponto de extremidade
GET https://rqrcode.com/api/projects/
Exemplo
curl --request GET \
--url 'https://rqrcode.com/api/projects/' \
--header 'Authorization: Bearer {api_key}'
Parâmetros
| Parâmetros | Detalhes | Descrição |
|---|---|---|
| page |
Opcional
ui.admin.api_docs.common.types.Inteiro
|
O número da página que você deseja obter os resultados. O padrão é 1. |
| results_per_page |
Opcional
ui.admin.api_docs.common.types.Inteiro
|
Quantos resultados você deseja por página. Os valores permitidos são: 10, 25, 50, 100, 250, 500, 1000. O padrão é 25. |
Exemplo de resposta
{
"data": [
{
"id": 1,
"name": "Desenvolvimento",
"color": "#0e23cc",
"last_datetime": null,
"datetime": "2026-04-20 07:54:04"
}
],
"meta": {
"page": 1,
"results_per_page": 25,
"total": 1,
"total_pages": 1
},
"links": {
"first": "https://rqrcode.com/api/projects?page=1",
"last": "https://rqrcode.com/api/projects?page=1",
"next": null,
"prev": null,
"self": "https://rqrcode.com/api/projects?page=1"
}
}
Ponto de extremidade
GET https://rqrcode.com/api/projects/{project_id}
Exemplo
curl --request GET \
--url 'https://rqrcode.com/api/projects/{project_id}' \
--header 'Authorization: Bearer {api_key}'
Parâmetros
Nenhum parâmetro adicional.
Exemplo de resposta
{
"data": {
"id": 1,
"name": "Desenvolvimento",
"color": "#0e23cc",
"last_datetime": null,
"datetime": "2026-04-20 07:54:04"
}
}
Ponto de extremidade
POST https://rqrcode.com/api/projects
Exemplo
curl --request POST \
--url 'https://rqrcode.com/api/projects' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Produção' \
--form 'color=#ffffff'
Parâmetros
| Parâmetros | Detalhes | Descrição |
|---|---|---|
| name |
Obrigatório
ui.admin.api_docs.common.types.Texto
|
— |
| color |
Opcional
ui.admin.api_docs.common.types.Texto
|
— |
Exemplo de resposta
{
"data": {
"id": 1
}
}
Ponto de extremidade
POST https://rqrcode.com/api/projects/{project_id}
Exemplo
curl --request POST \
--url 'https://rqrcode.com/api/projects/{project_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Produção' \
--form 'color=#000000'
Parâmetros
| Parâmetros | Detalhes | Descrição |
|---|---|---|
| name |
Opcional
ui.admin.api_docs.common.types.Texto
|
— |
| color |
Opcional
ui.admin.api_docs.common.types.Texto
|
— |
Exemplo de resposta
{
"data": {
"id": 1
}
}
Ponto de extremidade
DELETE https://rqrcode.com/api/projects/{project_id}
Exemplo
curl --request DELETE \
--url 'https://rqrcode.com/api/projects/{project_id}' \
--header 'Authorization: Bearer {api_key}'
Parâmetros
Nenhum parâmetro adicional.
Exemplo de resposta
Corpo de resposta 200 vazio em caso de sucesso.