We are considering building an API that will allow our partners to read data from our 6000-line Excel spreadsheet.

Our initial thoughts for the product would involve:
1. REST API Implementation:
a. The API will be a RESTful web service that allows clients to securely query the data stored in the financial data Excel file via HTTP requests. It will support the operation to retrieve data from our 6000 line spreashseet and return the information from several columns of the spreadsheet in JSON format.
b. The API will be able to handle up to 30 million queries per month, with the capacity to handle concurrent requests.
2. Authorization, Permissioning, and Tracking:
a. We will look to implement a permissioning and usage tracking system to manage access by partners. Each partner company will be issued a unique API key upon approval. API requests will require the key to be passed in the authorization header.
b. Usage will be logged and associated with the partner’s API key. Logs will be available to show metrics like total requests per day/month, and bandwidth usage by each partner. The API can be configured to be stopped if a partner exceeds their agreed upon usage limits.
c. Access levels will be defined as "read-only", as opposed to "read-write". Partners will be restricted to only the endpoints that align with their access level.
3. Uptime Guarantees:
a. The system will also track uptime and response time to ensure partners have a quality experience. b. After development, 99%+ uptime is guaranteed in the deployed product.
c. The service will be able to handle up 20 concurrent runs of the API from different users at the same time. (There is no restriction on the number of users that can query the API, but there will be capacity limits on the number of simultaneous requests at a time).
4. Spreadsheet Updates:
a. We’ll need a portal for administrators at CapGainsValet to be able to update the spreadsheet. The API will be able to handle periodic updates to cells, via an initiated PUT request to internal storage.
5. API Documentation Page
a. A page to show how partners can integrate with the API via GET request, will be provided, via HTML. This will include query parameters, success responses, and example outputs in JSON.

The API will only run from September through December of each year.  We will want to have access to the software developer during this annual window in case there are problems are updates are needed.

Hourly Range: $20.00-$50.00

Posted On: March 04, 2024 05:20 UTC
Category: Back-End Development
Skills:API, API Development, API Integration, PHP, JavaScript

Country: United States

click to apply