This method is used to authenticate with your application. It is responsible for verifying the supplied user credentials and establishing or renewing a connection. The authentication information will be stored in the metadata object and will be included in all request bodies. All applications must implement the Register method.
An object containing the authentication information gathered using the connection form you created for your application. It will contain whatever fields you defined in this form. Your method must then use this data to perform authentication with your backend service.
The Register method returns the result of the carrier's authentication process. This information will be included in the metadata of every subsequent request to your application.
{- "registration_info": {
- "username": "auctane-next-day",
- "password": "password!",
- "meter_number": "8675309"
}, - "transaction_id": "00000000-0000-0000-0000-000000000000",
- "metadata": {
- "username": "auctane-next-day",
- "password": "password!",
- "meter_number": "8675309"
}
}{- "credentials": {
- "username": "auctane-next-day",
- "password": "password!"
}, - "metadata": {
- "username": "auctane-next-day",
- "password": "password!",
- "meter_number": "8675309"
}
}