Skip to main content

Grade us Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow, DB-CDC, Spark ETL, or Replication data flow that sends data to a Grade us location.
grade_us_api.png

Grade us

Create a Grade us Destination

  1. Click the + icon on the Nexset that will be sent to the Grade us destination, and select the Send to Destination option from the menu.

  2. Select the Grade us connector from the list of available destination connectors. Then, select the credential that will be used to connect to the Grade us organization, and click Next; or, create a new Grade us credential for use in this flow.

  3. In Nexla, Grade us destinations can be created using pre-built endpoint templates, which expedite destination setup for common Grade us endpoints. Each template is designed specifically for the corresponding Grade us endpoint, making destination configuration easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

    Grade us destinations can also be configured manually, allowing you to send data to Grade us endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Grade us endpoints. Each template is designed specifically for the corresponding Grade us endpoint, making destination setup easy and efficient.

  • To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

    Create User

    This endpoint creates a User. Newly created Users will receive an email asking them to confirm their account and set their password unless send_system_emails is set to "false".

    • This endpoint automatically creates a new user in your Grade us account using data from your Nexset. No additional configuration is required beyond selecting this endpoint template.
    • The endpoint uses POST requests to https://grade.us/api/v4/users/. The endpoint URL is automatically constructed based on the Grade.us API base URL.
    • The endpoint sends data from your Nexset as the request body in JSON format. The request body is automatically formatted according to the schema fields and data mapping you configure. Each record in your Nexset will be sent as a JSON object containing the user data to create.
    • Batch mode is disabled by default for this endpoint. Each record in your Nexset will be sent as a separate API request to create a user. If you need to create multiple users, you can send multiple records, but each will be processed as a separate request.
    • This endpoint does not automatically create a data source to track the responses received from the Grade.us API after each call.

    The request body must be properly formatted JSON that matches the Grade.us API specification for creating users. The endpoint requires API Key authentication via the Authorization header, which is handled automatically by your credential configuration. The Content-Type: application/json header is automatically included in requests. Newly created users will receive an email asking them to confirm their account and set their password unless send_system_emails is set to false in the request body. Batch mode is disabled by default (batch.mode: false), so each record will be sent as a separate request. For detailed information about creating users, including required fields, field names, and request formats, see the Grade.us API documentation.

    Create Profile

    This endpoint creates a Profile. Certain attributes of a new Profile will be populated by standard defaults, but these attributes can also be sourced from a default profile that can be created manually in the Grade.us application.

    • This endpoint automatically creates a new profile in your Grade us account using data from your Nexset. No additional configuration is required beyond selecting this endpoint template.
    • The endpoint uses POST requests to https://grade.us/api/v4/profiles/. The endpoint URL is automatically constructed based on the Grade.us API base URL.
    • The endpoint sends data from your Nexset as the request body in JSON format. The request body is automatically formatted according to the schema fields and data mapping you configure. Each record in your Nexset will be sent as a JSON object containing the profile data to create.
    • Batch mode is disabled by default for this endpoint. Each record in your Nexset will be sent as a separate API request to create a profile. If you need to create multiple profiles, you can send multiple records, but each will be processed as a separate request.
    • This endpoint does not automatically create a data source to track the responses received from the Grade.us API after each call.

    The request body must be properly formatted JSON that matches the Grade.us API specification for creating profiles. The endpoint requires API Key authentication via the Authorization header, which is handled automatically by your credential configuration. The Content-Type: application/json header is automatically included in requests. Certain attributes of a new profile will be populated by standard defaults, but these attributes can also be sourced from a default profile that can be created manually in the Grade.us application. Batch mode is disabled by default (batch.mode: false), so each record will be sent as a separate request. For detailed information about creating profiles, including required fields, field names, and request formats, see the Grade.us API documentation.

Configure Manually

Grade us destinations can be manually configured to send data to any valid Grade us API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Grade us destinations, such as destinations that use custom request headers, different HTTP methods, or custom data formatting.

Content Format

  1. Select the format in which the Nexset data will be sent to the Grade us API from the Content Format pulldown menu. Nexla will automatically convert the data to the selected format for each API call. The Grade.us API typically uses JSON format for request bodies.

API Endpoint URL

  1. Enter the URL of the Grade us API endpoint to which you want to send the Nexset data in the URL field. This should be the complete URL including the protocol (https://) and any required path parameters. Grade.us API endpoints typically follow the pattern https://grade.us/api/v4/{endpoint_path}.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. The endpoint requires API Key authentication via the Authorization header, which is handled automatically by your credential configuration. For detailed information about Grade.us API endpoints and available APIs, see the Grade.us API documentation.