# Chemical Equation Balancer API Documentation ## :rocket: Quickstart Using cURL ```bash curl -X POST "https://infinitode.netlify.app/api/v1/chemical-equation-balancer" \ -H "Content-Type: application/json" \ -d '{"apiKey": "YOUR_API_TOKEN", "equation": "H + O -> H2"}' ``` ## Changelog * **1.2 (Latest)**: Updated API security. * **1.1**: Changed logic to use more accurate matrix multiplication for balancing, instead of ratio calculations. * **1.0**: Initial commit for API space. ## Access The API can be accessed from ```html https://infinitode.netlify.app/api/v1/chemical-equation-balancer ``` *** ## Authentication ### Bearer This API uses Bearer Token authentication. Include your API token in the `Authorization` header of your request. ``` Authorization: Bearer YOUR_API_TOKEN ``` {% hint style="info" %} You can also use the API with the default `GET` method, and continue to use the default `apiKey` or `token` parameters. When using the authorization bearer, `apiKey` or `token` parameters are automatically ignored. {% endhint %} ### API Token To use this API, you must include an API token in the request. The API token should be included in the request body as the `apiKey` field. ```json { "apiKey": "YOUR_API_TOKEN" } ``` You can also use the API with the default `GET` method. {% code overflow="wrap" %} ```url https://infinitode.netlify.app/api/v1/chemical-equation-balancer?token=YOUR_API_TOKEN ``` {% endcode %} *** ## Endpoint ### Balancing Endpoint URL: ``` https://infinitode.netlify.app/api/v1/chemical-equation-balancer ``` HTTP Methods: * `Post` * `Get` Request Body The request body should be a JSON object with the following properties: * `apiKey`: Your API token. * `equation`: Equation to be balanced. Example: ```json { "apiKey": "YOUR_API_TOKEN", "equation": "H + O -> H2O" } ``` Or, use the `GET` method: {% code overflow="wrap" %} ```url https://infinitode.netlify.app/api/v1/chemical-equation-balancer?token=YOUR_API_TOKEN&equation=H+O->H2O ``` {% endcode %} Response Upon a successful request, you will receive a JSON response with the balanced equation. If the API token is invalid or the request fails for any reason, an error message will be included in the response. For developer API calls, validation results will also be included along with **dummy content**. Example response: 
{
    "output": {
        "skeletonEquation": 'H2 + O2 -> H2O',
        "balancedEquation": '2 H2 + O2 -> 2 H2O',
        "elements": ['H', 'O']
    }
}
The response includes the balanced equation and validation results for the equation input are excluded, since this was a normal API call. *** ## Usage example Here's a usage example in JavaScript using the `fetch` API: ```javascript const apiUrl = 'https://infinitode.netlify.app/api/v1/chemical-equation-balancer' const data = { "apiKey": "YOUR_API_TOKEN", "equation": "H + O -> H2O" }; fetch(apiUrl, { method: 'POST', headers: { 'Content-Type': 'application/json', }, body: JSON.stringify(data), }) .then(response => response.json()) .then(result => { console.log('Balanced Equation Output:', result.output); }) .catch(error => { console.error('Error:', error); }); ``` Make sure to replace `'YOUR_API_TOKEN'` with your actual API token. *** ## Error handling The API may return error responses in case of invalid input or other issues. Be sure to handle errors gracefully in your application. Error responses will include appropriate status codes and error messages in the JSON format. *** ## Parameters Here are all the available parameters for the API: #### \`POST\` method | Parameter | Description | Optional | | ---------- | ------------------------------------------------------------------ | -------- | | `apiKey` | Your API key, either the developer API key, or your normal API key | `false` | | `equation` | The chemical equation (string) you want to balance. | `false` | #### \`GET\` method | Parameter | Description | Optional | | ---------- | ------------------------------------------------------------------ | -------- | | `token` | Your API key, either the developer API key, or your normal API key | `false` | | `equation` | The chemical equation (string) you want to balance. | `false` | *** ## :warning: Error codes Here are a few of the error codes, you will receive in responses, to help clarify issues: #### Common error codes
Error codeDescription
400Missing or invalid parameters. This is when the parameters you passed to the API, do not match the API's expected inputs.
405Using an invalid method, to access the API.
429The rate limit is exceeded within the current timeframe.
401Error during the request. This can be because of insufficient API calls, input errors, or errors arising from the API's logic.
{% hint style="info" %} Our APIs are rigorously tested before deployments, to ensure that they do not produce any unintentional errors during production. {% endhint %} *** ## :hourglass: Rate limiting We use rate limiting, to protect our API's resources. Rate limiting is implemented on all of our APIs, and follows these general principles: \ \- `interval`: The rate limiting is set to a default interval of `1 minute`.\ \- `amount of requests`: The amount of requests is set to a default of `25 requests` within the given interval. If the rate limit is exceeded, an error `429` code will be returned, instead of the actual API output. *** ## :star: Best practices Common guidelines to use, optimize, and protect your implementation of our APIs. * Do not store/share/expose your API keys * Implement data cleaning, and validation in your code, to ensure inputs are sanitized * Handle API errors gracefully * Use Developer API calls, to help debug your implementation and code * Handle API outputs accordingly. You can see examples of this API's output in the [#endpoint](#endpoint "mention") section. * Implement code to notify users of actions when using our APIs, such as errors, delays, formatting issues, etc. *** ## :question: FAQs Answers to the most common questions and issues when using this API:
I am getting a 405 error, what should I do? When you are getting a `404` or `NotFound` error, you likely misspelled the API endpoint or URL. This could also be caused by using an invalid method to access the API.
Is rate limiting set individually, or per API key? Rate limiting is set `individually`, this means that rate limiting happens on an end-user level. This ensures that our API is used fairly, among all users.
Are request timeouts a thing? Yes, we normally timeout requests after the 10-second mark. This, however, can vary significantly, depending on various other factors.
What is the max payload size? The maximum payload size for `buffered executions` is `4.5mb` per request. For `streamed executions`, we use a payload restriction size of `20mb` per request.
What is the recommended way to call the API? If you can, call the API using the `POST` method. The `GET` method works but is not recommended, especially when you're calling it by directly modifying the URL. This is because URL parameters that are strings, can sometimes be misformatted afterwards, and then incorrectly passed to the API.
Does the equation have to be in this format? Yes, the API looks for these symbols in your equation, and based on that, it can start its balancing logic. Without the special tokens like in the example, the API would not be able to recognize the chemical equation, and therefore not balance it.
*** ## OpenAPI You can download the OpenAPI specification for this API to learn more about how it works and how to use it. The OpenAPI specification is a standard, language-agnostic interface to RESTful APIs that allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. [Download OpenAPI Specification](https://infinitode.netlify.app/openapi/chemical-equation-balancer/openapi.yaml) *** ## Conclusion That's it! You now have the basics to use the Chemical Equation Balancer API. If you have any further questions or encounter issues, please contact our support team.