Yelp provider

This sample provider interfaces with the Yelp Fusion API to find local entities such as restaurants and parks using a valid postal code or city name. Click here to access the source code for the provider.

Set up the Provider

1. Run the cdf createapp yelp-app command to create a new custom data app or use an existing custom data app.
2. Run the cdf createprovider yelp-data-provider command to create a custom data provider.
3. Navigate to the providers/yelp-data-provider directory in a command prompt, and run the npm i yelp-fusion command.
4. Copy the contents of the src folder in the provided source code into the src folder inside your providers/yelp-data-provider/src directory.

Obtain an API Key

1. Follow the instructions in Yelp Fusion's developer documentation to obtain a private API key.

2. Once you have an API key, specify it in the providers/yelp-data-provider/default.json file as the value for the yelp.apiKey field as shown.

   Use dark colors for code blocksCopy

   1
   2
   3
   4
   5
   {
     "yelp": {
       "apiKey": "<generated API key here>"
     }
   }

Configure the Provider

1. In the providers/yelp-data-provider/cdconfig.json file, set the value of the properties.hosts field to true and properties.disabledIdParam field to false.

Test the Provider

1. Navigate to the yelp-app directory in a command prompt and run the npm start command to start the custom data app
2. In a web browser, navigate to http://localhost:8080/yelp-data-provider/rest/services/restaurants/redlands/FeatureServer/0/query and verify that the Yelp provider is returning data points.

Build and Deploy a Custom Data Provider Package File

1. Stop the custom data app if it's running.
2. Open a command prompt and navigate to the custom data app directory.
3. Run the cdf export yelp-data-provider command.
4. In a web browser, navigate to the ArcGIS Server Administrator Directory and sign in as an administrator.
5. Click uploads > upload.
6. On the Upload Item page, click Choose File and select the yelp-data-provider.cdpk file. Optionally, provide a description in the Description text box.
7. Click Upload. Once the file is uploaded, you will be directed to a page with the following header: Uploaded item - <item_id> . Copy the item id.
8. Browse back to the root of the Administrator Directory and then click services > types > customdataproviders.
9. On the Registered Customdata Providers page, click register and paste the item id into the Id of uploaded item field.
10. Click Register.

Create Feature Service

1. Browse back to the root of the Administrator Directory and click services > createService.

2. On the Create Service page, copy and paste the following JSON into the Service (in JSON format) text box.

   Use dark colors for code blocksCopy

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   27
   28
   29
   30
   31
   32
   33
   34
   35
   36
   37
   38
   {
     "serviceName": "yelpRedlands",
     "type": "FeatureServer",
     "description": "",
     "capabilities": "Query",
     "provider": "CUSTOMDATA",
     "clusterName": "default",
     "minInstancesPerNode": 0,
     "maxInstancesPerNode": 0,
     "instancesPerContainer": 1,
     "maxWaitTime": 60,
     "maxStartupTime": 300,
     "maxIdleTime": 1800,
     "maxUsageTime": 600,
     "loadBalancing": "ROUND_ROBIN",
     "isolationLevel": "HIGH",
     "configuredState": "STARTED",
     "recycleInterval": 24,
     "recycleStartTime": "00:00",
     "keepAliveInterval": 1800,
     "private": false,
     "isDefault": false,
     "maxUploadFileSize": 0,
     "allowedUploadFileTypes": "",
     "properties": {
       "disableCaching": "true"
     },
     "jsonProperties": {
       "customDataProviderInfo": {
         "dataProviderName": "yelp-data-provider",
         "dataProviderHost": "restaurants",
         "dataProviderId": "redlands"
       }
     },
     "extensions": [],
     "frameworkProperties": {},
     "datasets": []
   }

3. Click Create.

Consume Feature Service

To access the yelp feature service that you created in the previous section, use the appropriate URL (e.g., https://<domain_or_machine_name>/<webadaptor_name>/rest/services/yelpRedlands/FeatureServer). You can use this URL to consume data from Yelp in ArcGIS clients like ArcGIS Pro, ArcGIS Online, and ArcGIS Enterprise.