This API is intended for individuals and companies who create mobile apps.
If you are interested in a quick-to-install calculator for your website, see the box headlined "Website owner?" above the calculator at this website.
For the API, you may use method GET with a parameter composed of &-separated name=value sets. The response is JSON-encoded. Examples are further below.
(Optionally, you may use method POST instead of method GET. Post the same names and values in the same format as with method GET. The response for method GET and method POST are identical. See privacy note further below.)
The following name=value
sets are expected for the API's GET parameter:
id=testing
The value of id
may be "testing" while you are determining if the API will fit with your app. If you decide to use the API beyond a testing period, registration is required to obtain a unique id
value. (Do not rely on id value "testing" for production software.)
name=_________
The value of name
is the family name/last name for calculating the ancestral reading.
Here is an example GET URL to obtain a response from the API:
https://affinitynumerology.com/V3/calc/api_AncestorAttributes.php?id=testing&name=Bontrager
The response will be JSON-encoded. With the above GET URL, this would be the response (most reading text was removed for convenience here):
{"calc_number":1,"calc_reading":"<p>This -READING-TEXT-REMOVED- characteristics.<\/p>","received":{"id":"testing","name":"Bontrager"}}
Notice that the response includes the parameter information provided with the GET request (the id and the data used for the calculations).
Below is the above JSON decoded into an array.
Array
(
[calc_number] => 1
[calc_reading] => <p>This -READING-TEXT-REMOVED- characteristics.</p>
[received] => Array
(
[id] => testing
[name] => Bontrager
)
)
The [calc_number]
value is the ancestor number that the software calculated.
The [calc_reading]
value is the reading for the family name/last name that was calculated. (This generally is composed of several paragraphs.)
The [received]
array contains the values received when the API call was made.
Note: The API software checks that information is provided. It does not check validity.
To register for a unique id: Provide a contact name and email address and agree to place a "Calculations provided by AffinityNumerology.com" statement near the calculated results published in the app or another location within the app that has been negotiated and agreed to. (The statement may be translated to the language of the audience.) The affinitynumerology.com contact page may be used to register.
Privacy note: We do not store your user's personal information on the affinitynumerology.com server except, when method GET is used, the information is part of the request URL and is used to update the access logs, like all request URLs are. The access logs are required for full server operation. Use method POST to keep your user's personal information out of the request URL and the server access logs (which we do for website reading forms).