Este é o guia de documentação da API do nosso serviço. Aqui você encontrará informações sobre como utilizar a API para acessar e manipular os recursos disponíveis.
Para acessar a API, é necessário possuir uma chave de autenticação. Acesse este link para criar sua chave.
Atenção: Não compartilhe sua chave com terceiros. Caso a chave seja comprometida, delete-a imediatamente e crie uma nova.
Para facilitar a integração com a API, disponibilizamos uma biblioteca escrita em PHP.
Você pode encontrar o repositório da biblioteca no GitHub, em https://github.com/social-up/api-php.
The PING endpoint is a simple API endpoint that allows clients to test the connectivity and availability of a server. It is implemented as a single endpoint that clients can access by making an HTTP GET request. The server responds to the request with a simple message and a status code indicating the success or failure of the request. The primary purpose of the PING endpoint is to allow clients to quickly and easily verify that the server is up and running, and that it is reachable over the network.
| Header | Value |
|---|---|
| Accept |
application/vnd.api.v1+json
application/json
application/*+json
|
| Header | Value |
|---|---|
| Content-Type |
application/vnd.api.v1+json
application/json
application/*+json
|
| Allow | Comma-separated list of all HTTP methods allowed |
{
"ping": "pong"
}
Este endpoint retorna o saldo atual de uma conta de usuário. Ele exige que o usuário esteja autenticado e tenha as permissões corretas para acessar as informações de saldo. A resposta incluirá o saldo atual, bem como qualquer metadado relevante, como a moeda do saldo.
| Header | Value |
|---|---|
| Accept |
application/vnd.api.v1+json
application/hal+json
application/json
|
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
| Header | Value |
|---|---|
| Content-Type |
application/vnd.api.v1+json
application/hal+json
application/json
|
| Allow | Comma-separated list of all HTTP methods allowed |
{
"balance": "30.2850",
"currency": "BRL",
"_links": {
"self": {
"href": "/api/balance"
}
}
}
Este endpoint permite que o usuário consulte a lista de serviços disponíveis e os detalhes de um serviço específico. A resposta inclui o nome e o preço de cada serviço na lista. Para ver os detalhes de um serviço específico, basta consultar o serviço pelo seu id.
| Header | Value |
|---|---|
| Accept |
application/vnd.api.v1+json
application/hal+json
application/json
|
| Header | Value |
|---|---|
| Content-Type |
application/vnd.api.v1+json
application/hal+json
application/json
|
| Allow | Comma-separated list of all HTTP methods allowed |
| Header | Value |
|---|---|
| Accept |
application/vnd.api.v1+json
application/hal+json
application/json
|
| Header | Value |
|---|---|
| Content-Type |
application/vnd.api.v1+json
application/hal+json
application/json
|
| Allow | Comma-separated list of all HTTP methods allowed |
Este endpoint permite que os usuários façam pedidos de vários serviços, como seguidores, curtidas, visualizações, etc. Os usuários podem fornecer informações sobre o tipo de serviço e os detalhes específicos do pedido na solicitação. A resposta inclui a data em que o pedido foi feito, o status atual do pedido, o preço do serviço, o link para o conteúdo onde o serviço está sendo solicitado e a quantidade de seguidores, curtidas ou visualizações solicitadas. A resposta também inclui um código de status indicando o sucesso ou falha da solicitação.
| Header | Value |
|---|---|
| Accept |
application/vnd.api.v1+json
application/hal+json
application/json
|
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
| Header | Value |
|---|---|
| Content-Type |
application/vnd.api.v1+json
application/hal+json
application/json
|
| Allow | Comma-separated list of all HTTP methods allowed |
| Header | Value |
|---|---|
| Accept |
application/vnd.api.v1+json
application/hal+json
application/json
|
| Content-Type |
application/vnd.api.v1+json
application/json
|
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
| Header | Value |
|---|---|
| Content-Type |
application/vnd.api.v1+json
application/hal+json
application/json
|
| Allow | Comma-separated list of all HTTP methods allowed |
| Header | Value |
|---|---|
| Accept |
application/vnd.api.v1+json
application/hal+json
application/json
|
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
| Header | Value |
|---|---|
| Content-Type |
application/vnd.api.v1+json
application/hal+json
application/json
|
| Allow | Comma-separated list of all HTTP methods allowed |
Este endpoint permite que os usuários peçam reposição em seus pedidos. A resposta inclui o status da reposição e informações relevantes
| Header | Value |
|---|---|
| Accept |
application/vnd.api.v1+json
application/hal+json
application/json
|
| Content-Type |
application/vnd.api.v1+json
application/json
|
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
| Header | Value |
|---|---|
| Content-Type |
application/vnd.api.v1+json
application/hal+json
application/json
|
| Allow | Comma-separated list of all HTTP methods allowed |