RemotePC^™ Reseller APIs

A API RemotePC aceita solicitações e retorna respostas no formato 'JSON'. O mecanismo de autenticação por chave de API é usado junto com a lista de permissões de IP para autenticar as APIs. Para todas as APIs, a chave de API deve ser adicionada no cabeçalho de autorização.

Os revendedores podem enviar as solicitações de API usando a chave de API gerada para sua conta no console web.

Para obter a chave de API:

1. Faça login na sua conta RemotePC Revendedor.
2. Acesse a aba Minha conta e clique em API Keys.
3. Clique em View, insira a senha da conta e clique em View.
4. A chave de API será exibida. Clique em Copy Key para copiar para a área de transferência.

Para alterar a chave de API, clique em Change. Insira a senha da conta e clique em View para ver a nova chave de API.

1. Adicionar usuário

URL: https://web1.remotepc.com/rpc-api/reseller/private/user/add

            Method-Type: POST

            Request headers:

            

              
Authorization: Bearer <api key>
              
Content-type: application/json
            
          

Solicitação

            string firstName;

            string lastName;

            string invitedUserEmailId;

            string password;

            integer allotedComputers; //parâmetro opcional, o padrão é 0

            boolean sendEmailToUser; //notificação por e-mail ao usuário é um parâmetro opcional

          

Códigos de resposta HTTP

200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)

Exemplo de solicitação

{ "firstName": "firstname", "lastName": "lastname", "invitedUserEmailId": "[email protected]", "password": "password", "allotedComputers": 1, "sendEmailToUser": true }

Exemplo de resposta (Sucesso)

{ "status": "OK", "code": 200, "message": "SUCCESS" }

Exemplo de resposta de erro

{ "status": "BAD_REQUEST", "code": 400, "errorsCount": 1, "errors": [{ "description": "EMAIL_EXISTS" }] }

{ "status": "UNAUTHORIZED", "code": 401, "errorsCount": 1, "errors": [{ "description": "NOT_AUTHORIZED" }] }

{ "status": "INTERNAL_SERVER_ERROR", "code": 500, "errorsCount": 1, "errors": [{ "description": "INTERNAL_SERVER_ERROR" }] }

{ "status": "Forbidden", "code": 403, "errorsCount": 1, "errors": [{ "description": "Forbidden" }] }

A descrição pode incluir:

1. FIRSTNAME_REQUIRED,
2. LASTNAME_REQUIRED,
3. EMAILID_REQUIRED,
4. ENTER_VALID_EMAIL,
5. PASSWORD_REQUIRED,
6. INVALID_PASSWORD

2. Convidar usuários

URL: https://web1.remotepc.com/rpc-api/reseller/private/user/invite

            Method-Type: POST

            Request headers:

            

              
Authorization: Bearer <api key>
              
Content-type: application/json
            
          

Solicitação

            string invitedUserEmailId;

            integer allotedComputers; //parâmetro opcional, o padrão é 0

          

Códigos de resposta HTTP

200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)

Exemplo de solicitação

[{ "invitedUserEmailId": "[email protected]", "allotedComputers": 10 }]

Exemplo de resposta (Sucesso)

{ "status": "OK", "code": 200, "message": [{ "username": "[email protected]", "status": "ALREADY_INVITED" }, { "username": "[email protected]", "status": "EXISTS" }, { "username": "[email protected]", "status": "INVITED" }] }

Exemplo de resposta de erro

{ "status": "UNAUTHORIZED", "code": 401, "errorsCount": 1, "errors": [{ "description": "NOT_AUTHORIZED" }] }

{ "status": "INTERNAL_SERVER_ERROR", "code": 500, "errorsCount": 1, "errors": [{ "description": "INTERNAL_SERVER_ERROR" }] }

{ "status": "Forbidden", "code": 403, "errorsCount": 1, "errors": [{ "description": "Forbidden" }] }

3. Login do usuário

URL: https://web1.remotepc.com/rpc-api/reseller/private/user/signin

            Method-Type: POST

            Request headers:

            

              
Authorization: Bearer <api key>
              
Content-type: application/json
            
          

Solicitação

string username;
string password;

Códigos de resposta HTTP

200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)

Exemplo de solicitação

{ "username": "username", "password": "password" }

Exemplo de resposta (Sucesso)

{ "status": "OK", "code": 200, "message": { "rpc_redirect_link": "https://login.remotepc.com/rpcnew/process/autologin/eyJhbGciOiJIUzUxMiJ9" } }

Nota: Use rpc_redirect_link para fazer login automaticamente na conta.

Exemplo de resposta de erro

{ "status": "BAD_REQUEST", "code": 400, "errorsCount": 1, "errors": [{ "description": "USERNAME_DOES_NOT_EXIST" }] }

{ "status": "BAD_REQUEST", "code": 400, "errorsCount": 1, "errors": [{ "description": "ACTION_PARENT_ACCOUNT_SUSPENDED" }] }

{ "status": "BAD_REQUEST", "code": 400, "errorsCount": 1, "errors": [{ "description": "IP_ADDRESS_BLOCKED" }] }

{ "status": "BAD_REQUEST", "code": 400, "errorsCount": 1, "errors": [{ "description": "CANCELLED_ACCOUNT" }] }

A descrição pode incluir

EMAILID_REQUIRED,
INVALID_EMAIL,
PASSWORD_REQUIRED,
USERNAME_REQUIRED

{ "status": "UNAUTHORIZED", "code": 401, "errorsCount": 1, "errors": [{ "description": "NOT_AUTHORIZED" }] }

{ "status": "INTERNAL_SERVER_ERROR", "code": 500, "errorsCount": 1, "errors": [{ "description": "INTERNAL_SERVER_ERROR" }] }

4. Lista de usuários

URL: https://web1.remotepc.com/rpc-api/reseller/private/user/list

            Method-Type: POST

            Request headers:

            

              
Authorization: Bearer <api key>
              
Content-type: application/json
            
          

Códigos de resposta HTTP

200 (Success)
500 (Server Error)
401 (Unauthorized)

Exemplo de resposta (Sucesso)

{ "status": "OK", "code": 200, "message": { "resellerUsersList": [{ "alloted_computers": 1, "created_date": "01-13-2023", "isActive": true, "utilized_computers": 0, "username": "[email protected]" }] } }

Exemplo de resposta de erro

{ "status": "UNAUTHORIZED", "code": 401, "errorsCount": 1, "errors": [{ "description": "UNAUTHORIZED_ACCESS" }] }

{ "status": "INTERNAL_SERVER_ERROR", "code": 500, "errorsCount": 1, "errors": [{ "description": "INTERNAL_SERVER_ERROR" }] }