Anúncio: todos os projetos não comerciais registrados para usar o Earth Engine antes de
15 de abril de 2025 precisam
verificar a qualificação não comercial para manter o acesso ao Earth Engine.
ee.data.authenticateViaPrivateKey
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Configura a autenticação do lado do servidor de chamadas da API EE usando o cliente Node.js das APIs do Google. A autenticação de chave privada é estritamente para chamadas de API do lado do servidor. Para aplicativos baseados em navegador, use ee.data.authenticateViaOauth(). Nenhuma interação do usuário (por exemplo, um pop-up de autenticação) é necessária ao usar a autenticação do lado do servidor.
Esse ou outro método de autenticação precisa ser chamado antes de ee.initialize().
O token de autenticação será atualizado automaticamente quando possível. Você pode presumir com segurança que todas as chamadas assíncronas serão enviadas com as credenciais adequadas. No entanto, para chamadas síncronas, verifique se há um token de autenticação com ee.data.getAuthToken() e chame ee.data.refreshAuthToken() manualmente se não houver nenhum. A operação de atualização do token é assíncrona e não pode ser realizada nos bastidores, sob demanda, antes das chamadas síncronas.
Uso | Retorna |
---|
ee.data.authenticateViaPrivateKey(privateKey, success, error, extraScopes, suppressDefaultScopes) | |
Argumento | Tipo | Detalhes |
---|
privateKey | AuthPrivateKey | Conteúdo JSON da chave privada. |
success | Função, opcional | A função a ser chamada se a autenticação for bem-sucedida. |
error | Função, opcional | A função a ser chamada se a autenticação falhar, transmitindo a mensagem de erro. |
extraScopes | List<String>, opcional | Escopos OAuth extras a serem solicitados. |
suppressDefaultScopes | Booleano, opcional | Quando verdadeiro, apenas os escopos especificados em opt_extraScopes são solicitados. Os escopos padrão não são solicitados, a menos que sejam especificados explicitamente em opt_extraScopes. |
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-26 UTC.
[null,null,["Última atualização 2025-07-26 UTC."],[[["\u003cp\u003eEnables server-side authentication for Earth Engine API calls using a private key, suitable for non-browser environments.\u003c/p\u003e\n"],["\u003cp\u003eAuthentication happens automatically for asynchronous calls, but synchronous calls require manual token checks and refresh using \u003ccode\u003eee.data.getAuthToken()\u003c/code\u003e and \u003ccode\u003eee.data.refreshAuthToken()\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eee.data.authenticateViaPrivateKey()\u003c/code\u003e function facilitates this authentication process, accepting the private key and optional success/error callbacks, extra scopes, and a flag to suppress default scopes.\u003c/p\u003e\n"]]],[],null,["# ee.data.authenticateViaPrivateKey\n\n\u003cbr /\u003e\n\nConfigures server-side authentication of EE API calls through the Google APIs Node.js Client. Private key authentication is strictly for server-side API calls: for browser-based applications, use ee.data.authenticateViaOauth(). No user interaction (e.g. authentication popup) is necessary when using server-side authentication.\n\n\u003cbr /\u003e\n\nThis or another authentication method should be called before ee.initialize().\n\nThe auth token will be refreshed automatically when possible. You can safely assume that all async calls will be sent with the appropriate credentials. For synchronous calls, however, you should check for an auth token with ee.data.getAuthToken() and call ee.data.refreshAuthToken() manually if there is none. The token refresh operation is asynchronous and cannot be performed behind-the-scenes, on demand, prior to synchronous calls.\n\n| Usage | Returns |\n|------------------------------------------------------------------------------------------------------------------------|---------|\n| `ee.data.authenticateViaPrivateKey(privateKey, `*success* `, `*error* `, `*extraScopes* `, `*suppressDefaultScopes*`)` | |\n\n| Argument | Type | Details |\n|-------------------------|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `privateKey` | AuthPrivateKey | JSON content of private key. |\n| `success` | Function, optional | The function to call if authentication succeeded. |\n| `error` | Function, optional | The function to call if authentication failed, passed the error message. |\n| `extraScopes` | List\\\u003cString\\\u003e, optional | Extra OAuth scopes to request. |\n| `suppressDefaultScopes` | Boolean, optional | When true, only scopes specified in opt_extraScopes are requested; the default scopes are not not requested unless explicitly specified in opt_extraScopes. |"]]