Arquivos de configuração do ponto de conexão HTTPS

Atlas Device Sync, Atlas Edge Server, Data API e HTTPS Endpoints estão obsoletos. Consulte a página de descontinuação do para detalhes.

app/
└── https_endpoints/
    ├── config.json
    └── data_api_config.json

Configuração personalizada de ponto de conexão HTTPS

Defina as configurações de todos os HTTPS endpoints do seu aplicativo como uma array em https_endpoints/config.json.

[
  {
    "route": "<Endpoint Route Name>",
    "http_method": "<HTTP method>",
    "function_name": "<Endpoint function name",
    "validation_method": "<Authorization scheme>",
    "secret_name": "<Validation Secret Name>",
    "respond_result": <boolean>,
    "fetch_custom_user_data": <boolean>,
    "create_user_on_auth": <boolean>,
    "disabled": <boolean>
  }
]

Campo	Descrição
`route` `string`	A rota do endpoint.
`http_method` `string`	O tipo de método HTTP com o qual o endpoint lida. Especifique `` para lidar com todos os métodos com um único endpoint. Um dos seguintes: `"GET"` `"POST"` `"PUT"` `"PATCH"` `"DELETE"` `"DELETE"` `""`
`function_name` `string`	O nome da função associada ao endpoint. A função deve usar a assinatura da função do endpoint.
`validation_method` `string`	O esquema de autorização do endpoint usado para validar as solicitações recebidas. Um dos seguintes: `"SECRET_AS_QUERY_PARAM"` `"VERIFY_PAYLOAD"` `"NO_VALIDATION"`
`secret_name` `string`	O nome de um segredo que contém uma string. Se `validation_method` estiver definido como `SECRET_AS_QUERY_PARAM` ou `VERIFY_PAYLOAD`, esse segredo será usado para autorizar solicitações.
`respond_result` `boolean`	Se `true`, o endpoint retorna uma resposta HTTP personalizável para o cliente. Você configura a resposta chamando os métodos no objeto Response . Se você não configurar a resposta, o endpoint retornará uma resposta `200 - Ok` com o valor retornado da função do endpoint como o corpo da solicitação. Se `false`, as solicitações retornam uma resposta `204 - No Content` sem dados no corpo.
`fetch_custom_user_data` `boolean`	If `true`, o documento de dados de usuário personalizado do usuário autenticado está disponível via `context.user.custom_data`. Se `false`, os dados personalizados do usuário não são query e `context.user.custom_data` é um objeto vazio.
`create_user_on_auth` `boolean`	Se `true`, seu aplicativo criará automaticamente um novo usuário se as credenciais de usuário fornecidas forem autenticadas com sucesso, mas não estiverem associadas a um usuário existente. Essa configuração é útil para aplicativos que se integram ao sistema de autenticação externo por meio do provedor de autenticação JSON web token Personalizado. Se uma solicitação incluir um JSON web token válido do sistema externo que não corresponde a um usuário registrado, isso criará um novo usuário com o JSON web token como uma identidade.
`disabled` `boolean`	Habilita (`false`) ou desabilita (`true`) o endpoint.

Configuração da Data API

Defina a configuração dos endpoints da Data API gerados pelo seu aplicativo em https_endpoints/data_api_config.json.

{
  "disabled": <boolean>,
  "versions": ["v1"],
  "return_type": "EJSON" | "JSON",
  "create_user_on_auth": <boolean>,
  "run_as_system": <boolean>,
  "run_as_user_id": "<User Account ID>",
  "run_as_user_id_script_source": "<Function Source Code>"
}

Campo	Descrição
`disabled` `boolean`	Se `false`, a Data API não está habilitada. Os endpoints gerados não tratam nem respondem a solicitações.
`versions` `string[]`	Uma lista de versões da Data API compatíveis com seu aplicativo. A lista pode incluir um subconjunto de todas as versões possíveis, mas deve listar as versões em ordem crescente. Não é possível habilitar uma versão diferente da versão mais recente, mas todas as versões habilitadas anteriormente listadas aqui continuarão funcionando. Versões disponíveis: `"v1"`
`return_type` `string`	O formato de dados a ser usado para dados retornados por endpoints em corpos de resposta HTTPS. Um dos seguintes: `"EJSON"` `"JSON"`
`create_user_on_auth` `boolean`	Se `true`, seu aplicativo criará automaticamente um novo usuário se as credenciais de usuário fornecidas forem autenticadas com sucesso, mas não estiverem associadas a um usuário existente. Essa configuração é útil para aplicativos que se integram ao sistema de autenticação externo por meio do provedor de autenticação JSON web token Personalizado. Se uma solicitação incluir um JSON web token válido do sistema externo que não corresponde a um usuário registrado, isso criará um novo usuário com o JSON web token como uma identidade.
`run_as_user_id` `string`	ID da conta de um usuário do aplicativo. Se definidos, os endpoints sempre serão executados da forma como o usuário especificou. Não é possível usar com `run_as_user_id_script_source`.
`run_as_user_id_script_source` `string`	Código fonte em string para uma função que retorna o ID da conta de um usuário do aplicativo. Se definidos, os endpoints executam a função em cada solicitação e são executados como o usuário com o ID retornado da função. Não é possível usar com `run_as_user_id`.

Voltar

Hospedagem estática

Encaminhadores de registros