Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| @@ -0,0 +1,29 @@ | |||
| API Integration Guide | |||
There was a problem hiding this comment.
Sugestão de Voz Ativa (AI) 🤖
| API Integration Guide | |
| "You wrote the API Integration Guide." |
| @@ -0,0 +1,29 @@ | |||
| API Integration Guide | |||
|
|
|||
| Authentication | |||
There was a problem hiding this comment.
Sugestão de Voz Ativa (AI) 🤖
| Authentication | |
| "You authenticate." |
|
|
||
| Authentication | ||
|
|
||
| To access the private endpoints, an API key is required. |
There was a problem hiding this comment.
Sugestão de Voz Ativa (AI) 🤖
| To access the private endpoints, an API key is required. | |
| "You require an API key to access the private endpoints." |
| Authentication | ||
|
|
||
| To access the private endpoints, an API key is required. | ||
| The key can be generated in the user settings dashboard. |
There was a problem hiding this comment.
Sugestão de Voz Ativa (AI) 🤖
| The key can be generated in the user settings dashboard. | |
| You can generate the key in the user settings dashboard. |
|
|
||
| To access the private endpoints, an API key is required. | ||
| The key can be generated in the user settings dashboard. | ||
| Once obtained, the key must be included in the header of every request. |
There was a problem hiding this comment.
Sugestão de Voz Ativa (AI) 🤖
| Once obtained, the key must be included in the header of every request. | |
| "You must include the key in the header of every request once you have obtained it." |
| The key can be generated in the user settings dashboard. | ||
| Once obtained, the key must be included in the header of every request. | ||
|
|
||
| Authorization: Bearer <YOUR_API_KEY> |
There was a problem hiding this comment.
Sugestão de Voz Ativa (AI) 🤖
| Authorization: Bearer <YOUR_API_KEY> | |
| "You have provided the authorization: Bearer <YOUR_API_KEY>" |
| Authorization: Bearer <YOUR_API_KEY> | ||
|
|
||
|
|
||
| Creating a User |
There was a problem hiding this comment.
Sugestão de Voz Ativa (AI) 🤖
| Creating a User | |
| "You create a User" |
|
|
||
| Creating a User | ||
|
|
||
| A user is created by sending a POST request to /api/users. |
There was a problem hiding this comment.
Sugestão de Voz Ativa (AI) 🤖
| A user is created by sending a POST request to /api/users. | |
| "You create a user by sending a POST request to /api/users." |
| Creating a User | ||
|
|
||
| A user is created by sending a POST request to /api/users. | ||
| The following JSON body is expected by the server: |
There was a problem hiding this comment.
Sugestão de Voz Ativa (AI) 🤖
| The following JSON body is expected by the server: | |
| "You are expected to provide the following JSON body to the server:" |
| A user is created by sending a POST request to /api/users. | ||
| The following JSON body is expected by the server: | ||
|
|
||
| { |
There was a problem hiding this comment.
Sugestão de Voz Ativa (AI) 🤖
| { | |
| { | |
| The following JSON body is expected by the server: | ||
|
|
||
| { | ||
| "username": "jdoe", |
There was a problem hiding this comment.
Sugestão de Voz Ativa (AI) 🤖
| "username": "jdoe", | |
| `"username": "jdoe","` |
|
|
||
| { | ||
| "username": "jdoe", | ||
| "email": "jdoe@example.com" |
There was a problem hiding this comment.
Sugestão de Voz Ativa (AI) 🤖
| "email": "jdoe@example.com" | |
| `"email": "jdoe@example.com"` |
| { | ||
| "username": "jdoe", | ||
| "email": "jdoe@example.com" | ||
| } |
There was a problem hiding this comment.
Sugestão de Voz Ativa (AI) 🤖
| } | |
| } | |
| } | ||
|
|
||
|
|
||
| If the request is successful, a 201 Created status is returned. |
There was a problem hiding this comment.
Sugestão de Voz Ativa (AI) 🤖
| If the request is successful, a 201 Created status is returned. | |
| "If the request is successful, you return a 201 Created status." |
|
|
||
|
|
||
| If the request is successful, a 201 Created status is returned. | ||
| However, if the data is invalid, a 400 Bad Request error is thrown. |
There was a problem hiding this comment.
Sugestão de Voz Ativa (AI) 🤖
| However, if the data is invalid, a 400 Bad Request error is thrown. | |
| "However, if the data is invalid, you throw a 400 Bad Request error." |
| If the request is successful, a 201 Created status is returned. | ||
| However, if the data is invalid, a 400 Bad Request error is thrown. | ||
|
|
||
| Rate Limiting |
There was a problem hiding this comment.
Sugestão de Voz Ativa (AI) 🤖
| Rate Limiting | |
| "Rate Limiting" |
|
|
||
| Rate Limiting | ||
|
|
||
| Requests are limited to 100 per minute. |
There was a problem hiding this comment.
Sugestão de Voz Ativa (AI) 🤖
| Requests are limited to 100 per minute. | |
| "You are limited to 100 requests per minute." |
| Rate Limiting | ||
|
|
||
| Requests are limited to 100 per minute. | ||
| If this limit is exceeded, the client is blocked for 60 seconds. No newline at end of file |
There was a problem hiding this comment.
Sugestão de Voz Ativa (AI) 🤖
| If this limit is exceeded, the client is blocked for 60 seconds. | |
| "You exceed this limit, we block the client for 60 seconds." |
No description provided.