Home Page

Introduction

The PPFA API provides you with a convenient and simple Web services API for getting data from PPFA database.

Everytime you make a call to any service, you need to add a Token Key to request header. Token Key is an Unique Identifier for each PPFA API integration. We provide each application a private token to enhance the security.

Also, we listed here API resources (URIs), sample codes and demos that can help you to understand how PPFA API works.

API Resources

Name

URI

HTTP Method

Format: {{apiMethod.format}}

Request Parameters:

Name	Required?	Type	Description
{{param.name}}	{{param.required}}	{{param.type}}	{{param.description}}

{{param.name}} Object:

Name	Required?	Type	Description
{{prop.name}}	{{prop.required}}	{{prop.type}}	{{prop.description}}

Example Request Body:

                                    
                                         {{apiMethod.request.example}}

Response:

Example Response Body:

                                    
                                        {{apiMethod.response.example}}

How to use the API ?

HTTP GET

                        
                                $.ajax({
                                    type: "GET",
                                    headers: {
                                        "Token": "2794B914-E231-41C9-9D2A-3B9BD6B94098"
                                    },
                                    url: "https://api.data.ppfa.net/api/affiliates/year=18",
                                    success: function (resp) {
                                        console.log(resp);
                                    },
                                    error: function (err) {
                                        console.log(err);
                                    }
                                });

                        
                             using (var client = new HttpClient())
                                {
                                    client.BaseAddress = new Uri("https://api.data.ppfa.net/api/");
                                    client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
                                    client.DefaultRequestHeaders.Add("Token", "2794B914-E231-41C9-9D2A-3B9BD6B94098");
                                    HttpResponseMessage response = client.GetAsync("affiliates/year=18").Result;
                                    if (response.IsSuccessStatusCode)
                                    {
                                        Console.WriteLine(response.Content.ReadAsStringAsync().Result);
                                    }
                                    else
                                    {
                                        Console.WriteLine(string.Format("{0} ({1})", (int)response.StatusCode, response.ReasonPhrase));
                                    }  
                                }

Affiliate ID	Legacy Affiliate ID	Affiliate Name
{{item.affiliateID}}	{{item.legacyAffiliateID}}	{{item.affiliateShortName}}

Url: {{demoGet.url}}

Response body

                                    
                                                {{demoGet.arrAffiliatesJson}}

Zipcode

Name	Hours	Address	Phone number	Fax number	Email
{{item.name}}	{{item.hours}}	{{item.address}}	{{item.phoneNumber}}	{{item.faxNumber}}	{{item.email}}

Url: {{demoGetHealthCenters.url}}

Response body

                                    
                                                {{demoGetHealthCenters.healthCentersArrJson}}

No data!

HTTP POST

                        
                                var dataPost = { ancillaryID: 21417, person: {personID: null, facilityPersonID: null, firstName:'Doe', lastName:'Jane', email:'jane@data.ppfa.net', position:'CEO'}}
                                 $.ajax({
                                    type: "POST",
                                    url: "https://api.data.ppfa.net/api/people/insert",
                                    data:JSON.stringify(dataPost),
                                    headers: {
                                        'Content-Type': 'application/json; charset=utf-8',
                                        'X-Requested-With': 'XMLHttpRequest',
                                        'Token': '2794B914-E231-41C9-9D2A-3B9BD6B94098'
                                    },
                                    success: function (resp) {
                                        console.log(resp);
                                    },
                                    error: function (err) {
                                        console.log(err);
                                    }
                                });

                        
                            using (var client = new HttpClient())
                            {
                                client.BaseAddress = new Uri("https://api.data.ppfa.net/api/");
                                client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
                                client.DefaultRequestHeaders.Add("Token", "2794B914-E231-41C9-9D2A-3B9BD6B94098");
                                
                                var data = "{ ancillaryID: 21417, person: {personID: null, facilityPersonID: null, firstName:'Doe', lastName:'Jane', email:'jane@data.ppfa.net', position:'CEO'}}";
                                HttpContent content = new StringContent(data, UTF8Encoding.UTF8, "application/json");
                                HttpResponseMessage response = client.PostAsync("people/insert", content).Result;
                                if (response.IsSuccessStatusCode)
                                {
                                    Console.WriteLine(response.Content.ReadAsStringAsync().Result);
                                }
                                else
                                {
                                    Console.WriteLine(string.Format("{0} ({1})", (int)response.StatusCode, response.ReasonPhrase));
                                }
                            }

Affiliate:

Ancillary:*

First Name:*

Last Name:*

Email:*

Position:

Person Id	First name	Last name	Email	Position
{{person.personID}}	{{person.firstName}}	{{person.lastName}}	{{person.email}}	{{person.position}}
No data

Url: {{demoPost.url}}

Request body

                                            
                                                    {{demoPost.requestBody}}

Response body

                                            
                                                    {{demoPost.responseBody}}

Latitude

Longitude

Buffer

Name	Hours	Address	Phone number	Fax number	Email
{{item.name}}	{{item.hours}}	{{item.address}}	{{item.phoneNumber}}	{{item.faxNumber}}	{{item.email}}

Url: {{demoGetHealthCentersByGeoCode.url}}

Response body

                                    
                                                {{demoGetHealthCentersByGeoCode.healthCentersArrJson}}

No data!

Introduction

API Resources

{{api.name}}

How to use the API ?