Resources

Renesas IoT Sandbox Documentation

Credentials Library

These functions provide access to a Credential store. The purpose of using this library is to allow retrieval of credentials from within a workflow so that they can be maintained in one place without the need to update code when credentials are updated. The 3rd Party APIs that Renesas IoT Sandbox currently supports are Twilio (SMS), Mandrill (email), Google (Location), Google (Calendar), Maxmind (IP Geolocation), and Zendesk (support tickets).

Credentials for external APIs can be defined under Setup -> External APIs.


Import


To use this library and its functions, you must use the import line at the beginning of your Base Python code.

import Credentials



Functions


Credentials.use

Usage: Credentials.use(credential_id)

Retrieves credentials from store. Credential ID can be found under Setup -> External APIs.
The object retrieved contains {key: value} pairs where the key is the name of the parameter required by the external API

  • Credit cost: 0
  • Parameters:
    • credential_id: str the ID string correspodning to the credential.
  • Returns: object
  • Example:

    • Sample Code:

      import Credentials
      creds = Credentials.use("299596909574889472")
      
      # sets 'creds' to {"API key": "ADFIJHIRNR-KHFJBR-DKJFEHIRU-DJWIHEFRU", "username": "myusername"}

Getting Started
User Roles & Permissions
Streams, Tags, & Data Types
Dashboard Widgets
API
Workflow Studio
Workflow Libraries
Metering
Special Characters
Third Party Integration
Mobile
API Explorer

Credentials Library

These functions provide access to a Credential store. The purpose of using this library is to allow retrieval of credentials from within a workflow so that they can be maintained in one place without the need to update code when credentials are updated. The 3rd Party APIs that Renesas IoT Sandbox currently supports are Twilio (SMS), Mandrill (email), Google (Location), Google (Calendar), Maxmind (IP Geolocation), and Zendesk (support tickets).

Credentials for external APIs can be defined under Setup -> External APIs.


Import


To use this library and its functions, you must use the import line at the beginning of your Base Python code.

import Credentials



Functions


Credentials.use

Usage: Credentials.use(credential_id)

Retrieves credentials from store. Credential ID can be found under Setup -> External APIs.
The object retrieved contains {key: value} pairs where the key is the name of the parameter required by the external API

  • Credit cost: 0
  • Parameters:
    • credential_id: str the ID string correspodning to the credential.
  • Returns: object
  • Example:

    • Sample Code:

      import Credentials
      creds = Credentials.use("299596909574889472")
      
      # sets 'creds' to {"API key": "ADFIJHIRNR-KHFJBR-DKJFEHIRU-DJWIHEFRU", "username": "myusername"}