Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
1. Starter Guide Make a Call in 5 Minutes!
Clone this wiki locally
Welcome to XapiX! Now that you’ve joined our platform, you’re ready to begin discovering, combining, and integrating the APIs you need for your project. This guide will give you a step by step lesson in how to get going.
Step 1: Select API Endpoints from the marketplace
On the marketplace page, you’ll see a list of API providers to choose from. Within each, you’ll also have access to the list of available endpoints that the provider offers. Select which endpoints you would like to use. Feel free to select as many as you like--the ability to combine them is one of XapiX’s big advantages!
Step 2: Configure those endpoints
Once you’ve finalized the endpoints you’d like to use for your project, you can begin to configure them. This process involves three steps: Authentication, Parameter Entry, and Attribute Selection.
Every API has its own method of authentication. For each endpoint you selected, you will have to provide the proper authentication credentials to access the API it comes from. If you haven’t registered with the original API provider already, you can find a link to the API’s signup page on this step. Once you’ve obtained the proper credentials, enter them into the appropriate fields. A lock icon will tell you whether your key works or not. If it’s green, you are good to click next.
On the next screen, you will be prompted to enter in both the required and optional parameters for the endpoint you’ve selected--if either of them exist. If they don’t, the API endpoint doesn’t require any params. If you’re not sure what the parameters should look like, you can follow the provided link for more information. There is an example for each parameter that can help you identify the type of entry required. As you enter your params, you can also immediately see the output on the console generated with your key on the right side of the screen.
On the following screen, you’ll be presented with a list of the attributes returned by your chosen endpoint. In our early version, you can just see all endpoints, but in a few weeks you will be able to choose them on an individual level. This way, in the future you can leave out any information you don’t want or need, making your own XapiX endpoint as clean and simple as possible.
Once you’re done preparing your attributes, your endpoint is ready to go! Click next to move on to the next step.
Step 3: Create a union via schemas
Now that you’ve set up your endpoints the way you like, XapiX will check whether some of them provide similar information that you might want to combine. If we find such a matching schema, you’ll be able to give priority to the information from a specific API endpoint and increase your data reliability and integrity overall. Using the dropdowns and radio buttons, you can set the API order of priority for reporting each attribute.
What is this and why does it matter?
In the world of APIs, information generally does not follow one universal standard--it is a mess (...but you know that!). As such, data from multiple sources often can’t be combined easily because each source may use different naming conventions, different data structures or types, or different levels of specificity. With that in mind, how can you ensure that the data you want is the data you get?
That’s where generic schemas can help you. When you select endpoints with information that match a schema, you can use the dropdowns and radio buttons to create a union over these endpoints to pick which API you would like your attribute to draw from. By doing so you can increase the integrity and quality of the data you’re gathering, ensuring a higher level of uniformity and usability.
For a deeper dive into our schemas, read more about them here.
Step 4: Integrate your API
Congratulations, you have successfully modeled your new API at this point! Under the “Configuration and installation” heading, you will find all the information you need to use your XapiX API.
Under the “Use your API” heading, you will find individual information on each of your API’s endpoints, along with the ability to test them in the console on the right side of the page. To test an individual endpoint, click the “Select for Testing” button (which will change to “Currently Testing”) and you will be able to see a live example in the console. When the call is successful, you’re ready to go!
(Note: the sample image above uses placeholder data in the console; your live API’s data will reflect your own configuration.)
Step 5 - Manage your API coming soon
XapiX provides several analytic tools for you to gain a better understanding of usage of your API from a user and infrastructure perspective. Use it for your own app and share your API with other user and the XapiX community.