RemotePC API aceita pedidos e devolve respostas no formato 'JSON'. O mecanismo de autenticação da chave API é utilizado juntamente com a lista branca de IP para autenticar as APIs. Para todas as APIs, a Chave de API deve ser adicionada no cabeçalho da autorização.
Os revendedores podem enviar os pedidos API utilizando a chave API gerada para a sua conta na consola web.
Para obter a chave API,
- Inicie a sessão na sua conta de Revendedor RemotePC.
- Ir para o separador A minha conta e clicar nas teclas API.
- Clique em Ver, introduza a password da conta, e clique em Ver.
- A chave API será exibida. Clique em Copy Key para copiar para a área de transferência.
Para alterar a chave API, clique em Change. Introduza a palavra-passe da conta e clique em Ver para ver a nova chave API.
1. Adicionar utilizador
URL: https://web1.remotepc.com/rpc-api/reseller/private/user/add
Método-Tipo: LUGAR
Pedir cabeçalhos:
- Authorization: Bearer <api key>
- Tipo de conteúdo: aplicação/json
Pedido
primeiro nome do cordel;
últimoNome da corda;
string convidadoUserEmailId;
palavra-chave da cadeia de caracteres;
integer allotedComputers; //parâmetro opcional, por defeito é 0
boolean sendEmailToUser; // notificação por e-mail ao utilizador é um parâmetro opcional
Códigos de resposta HTTP
200 (Sucesso)
500 (Erro do Servidor)
400 (Parâmetros inválidos)
401 (Não Autorizado)
403 (Pedido inválido)
Pedir amostra
{
"firstName": "firstname",
"lastName": "lastname",
"invitedUserEmailId": "[email protected]",
"password": "password",
"allotedComputers": 1,
"sendEmailToUser": true
}
Resposta
Amostra de sucesso de resposta
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Amostra de erro de resposta
{
"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:
- PRIMEIRO_NOME_REQUERIDO,
- ÚLTIMO_NOME_REQUERIDO,
- EMAILID_REQUIRED,
- ENTER_VALID_EMAIL,
- PASSWORD_REQUIRED,
- PALAVRAS_PASSE_INVALIDAS
2. Convidar utilizadores
URL: https://web1.remotepc.com/rpc-api/reseller/private/user/invite
Método-Tipo: LUGAR
Pedir cabeçalhos:
- Authorization: Bearer <api key>
- Tipo de conteúdo: aplicação/json
Pedido
string convidadoUserEmailId;
integer allotedComputers; // parâmetro opcional, por defeito é 0
Códigos de resposta HTTP
200 (Sucesso)
500 (Erro do Servidor)
400 (Parâmetros inválidos)
401 (Não Autorizado)
403 (Pedido inválido)
Pedir amostra
[
{
"invitedUserEmailId": "[email protected]",
"allotedComputers": 10
}
]
Amostra de sucesso de resposta
{
"status": "OK",
"code": 200,
"message": [
{
"username": "[email protected]",
"status": "ALREADY_INVITED"
},
{
"username": "[email protected]",
"status": "EXISTS"
},
{
"username": "[email protected]",
"status": "INVITED"
}
]
}
Amostra de erro de resposta
{
"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. Ingresso do utilizador
URL: https://web1.remotepc.com/rpc-api/reseller/private/user/signin
Método-Tipo: LUGAR
Pedir cabeçalhos:
- Authorization: Bearer <api key>
- Tipo de conteúdo: aplicação/json
Pedido
nome de utilizador da cadeia;
palavra-chave da cadeia de caracteres;
Códigos de resposta HTTP
200 (Sucesso)
500 (Erro do Servidor)
400 (Parâmetros inválidos)
401 (Não Autorizado)
403 (Pedido inválido)
Pedir amostra
{
"username": "username",
"password": "password"
}
Resposta
Amostra de sucesso de resposta
{
"status": "OK",
"code": 200,
"message": {
"rpc_redirect_link":"https://login.remotepc.com/rpcnew/process/autologin/eyJhbGciOiJIUzUxMiJ9"
}
}
Nota: Utilize rpc_redirect_link para fazer o login automático na conta.
Amostra de erro de resposta
{
"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 utilizadores
URL:https://web1.remotepc.com/rpc-api/reseller/private/user/list
Método-Tipo: LUGAR
Pedir cabeçalhos:
- Authorization: Bearer <api key>
- Tipo de conteúdo: aplicação/json
Códigos de resposta HTTP
200 (Sucesso)
500 (Erro do Servidor)
401 (Não Autorizado)
Resposta
Amostra de sucesso de resposta
{
"status": "OK",
"code": 200,
"message":{
"resellerUsersList": [
{
"alloted_computers": 1,
"created_date": "01-13-2023",
"isActive": true,
"utilized_computers": 0,
"username": "[email protected]"
},
{
"alloted_computers": 1,
"created_date": "01-13-2023",
"isActive": true,
"utilized_computers": 0,
"username": "[email protected]"
},
{
"alloted_computers": 0,
"created_date": "01-15-2023",
"isActive": true,
"utilized_computers": 0,
"username": "[email protected]"
},
{
"alloted_computers": 0,
"created_date": "01-15-2023",
"isActive": true,
"utilized_computers": 0,
"username": "[email protected]"
},
{
"alloted_computers": 0,
"created_date": "01-15-2023",
"isActive": true,
"utilized_computers": 0,
"username": "[email protected]"
},
{
"alloted_computers": 425,
"created_date": "01-25-2023",
"isActive": true,
"utilized_computers": 0,
"username": "[email protected]"
}
]
}
}
Amostra de erro de resposta
{
"status": "UNAUTHORIZED",
"code": 401,
"errorsCount": 1,
"errors": [
{
"description": "UNAUTHORIZED_ACCCESS"
}
]
}
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}