- It will change the response keys text as a requested case.
- default, it will not change the response.
- Transform into a string with the separator denoted by the next word capitalized.
- Transform into a space separated string with each word capitalized.
- Transform into an upper case string with an underscore between words.
- Transform into a lower case string with a period between words.
- Transform into a dash separated string of capitalized words.
- Transform into a lower cased string with spaces between words.
- Transform into a lower cased string with dashes between words.
- Transform into a string of capitalized words without separators.
- Transform into a lower case string with slashes between words.
- Transform into a lower case with spaces between words, then capitalize the string.
- Transform into a lower case string with underscores between words.
- To get the flat response we use this request header.
- Default, does not change response.
- A deep populated response gets in the flat object. The fields are separated with an underscore(_).
- To get the meta-data of the requested API.
- Default does not get meta-data information in response.
- Provide specific information about the requested API and user.
- executionTime - Execution time is taken by API Maker. It does not include network travel time.
- executionPlan - It will return the execution plan of MongoDb.
- apiAccessGroups - Give information about the API user group and permission.
- runBy - It will return information about the sandbox which was run the code.
- Provide a secret in 'x-am-secret' and use secret values in your code.
- A secret has an encryption algorithm, and it's keys to encrypt/decrypt.
- Used in [encryption, decryption] property conversion.
- If 'nonce' is not available, 'secret' will be used for hashing.
- Do not change the value of 'secret' and do not share it with anyone or any application.
- Default hashing algorithm for generating the hash.
- Secret has an encryption algorithm for URL, query params, body, and whole request API, and it's the secret key.
- Used in [encryptData, decryptData] system API calls.
- Used to decrypt data, sent by frontend or mobile app or any client.
- secretFETransfer can be shared with FE/mobile app, so the backend can decrypt data sent by them, and they can decrypt data shared by the backend.
- Secret contains database connection strings too.
- We can get backend error messages in any user language and directly show them to the user in UI, so the user can take appropriate actions.
- Set symbols, and special characters, as a response error message.
- Provide the internationalization name in the header, and you will get an error message in your provided language.
- No need to restart the project, just change the error message, and it will be reflected immediately.
- You can add as many as you require internationalization.
Default error response ["x-am-internationalization": "Default"]
response in Hindi language ["x-am-internationalization": "Hindi"]
response in Chinese(Simplified) language ["x-am-internationalization": "Chinese simple"]
response in Spanish language ["x-am-internationalization": "Spanish"]
response in Japanese language ["x-am-internationalization": "Japanese"]
response in Urdu language ["x-am-internationalization": "Urdu"]
- The system will try to run requests in the maximum provided sandbox, so if 1 is provided every request will run in one sandbox only even if we have multiple sandboxes with multiple API Maker instances.
It can run in any sandbox
It can run in only one sandbox.
Run in any first 2 sandbox
Run in any first 3 sandbox
- We can provide a response type in the request header. As provided header value we can expect the response type.
- Get response in json format.
- Get response in XML format.
- Get response in YAML format.
- It will use to reset the requested API's cache. The response will not get from the cache.
No action to cache
- It is the default value and it will do nothing.
- If caching enable then it will get a response from the cache.
You will get 'x-am-data-source:cache' in the response header if we do not reset the existing cache.
- It is the default value and it will do nothing.
- If caching enable or not, it will get a response from the database.
You will get 'x-am-data-source:api' in the response header.
- To get response data encrypted we have to provide "x-am-get-encrypted-data" in the header.
- The encryption method is used from the default secret.
- Nothing change in response.
Get only encryption
- Get only encrypted data in response.
Get data and encryption
- Get normal data and encrypted data both in a single response.
- 'x-am-authorization' contains a token of the API Maker's API user.
- The end user must have to provide x-am-authorization in every API request.
- "x-am-user-authorization" contains the token of the end user.
- When users log in they got them tokens.
- The API user has to provide x-am-user-authorization in every request which has access_type=TOKEN_ACCESS.
- API Maker admin can set the access type of the collection.
- If API Maker's admin did the configuration in API Maker to take a token for AWS Cognito, the API user must pass the AWS Cognito token value in the 'x-aws-authorization' header.
- If API Maker's admin did the configuration in API Maker to take a token for a Google user, the API user must pass the Google user token value in the 'x-google-authorization' header.
- If API Maker's admin did the configuration in API Maker to take a token for Azure Active Directory, the API user must pass the Azure Active Directory token value in the 'x-azure-authorization' header.
- API Maker admin can set the number of response characters in "maxCharsResToCache". Its value must be an integer number.
- If a user sends 'x-no-compression:true' then it will not compress the response.
- If the user does not send 'x-no-compression' in the request header, and the response characters are more than the value of "maxCharsResToCache" than the response will be compressed with browser default encoding methods.
- The encoding methods provide in request headers with "Accept-Encoding: gzip, deflate, br".
- The code is run in a sandbox and gives a response.
- The default sandbox timeout is 13 seconds. Users can change the sandbox timeout provided in the "x-am-sandbox-timeout" header.
- If any API did not give a response within 13 seconds, the sandbox will break and give a proper error message in the response.
- "x-am-sandbox-timeout" takes an integer number value. It has a millisecond unit.
- When the user sent an encrypted payload, the user must have to send "x-am-encrypted-payload:true".