[DT-M3] Create dt-maarifa API to receive contact and interaction data #2

adventureit · 2024-09-26T08:30:09Z

The Maarifa RS currently uses built-in DT APIs to create contacts and comments. This mostly suits our needs right now, but some options to expand the Maarifa Plugin features could use their own API.

Creating 3 endpoints just for the Maarifa Plugin that the RS will send data to directly and DT can handle some special cases better.

-POST /wp-json/dt-maarifa/v1/contacts
-POST /wp-json/dt-maarifa/v1/contacts/:id
-POST /wp-json/dt-maarifa/v1/contacts/:id/interactions

3 endpoints created. 1st - Create new contact/update if maarifa_data already exists - Ok, if using DT json formating; 2nd - Update based on DT id - Ok, if using DT json formating; 3rd - Create/update interactions - In progress. Create and update are Ok, if using DT json formating, but needs to add some fields. It also remains to map the DT x Maarifa fields and use it before performing the above actions.

… - Maping Maarifa x DT fields Creating function mapFieldsToContact to map Maarifa x DT Fields and contemplate differences and exceptions.

Mapping Maarifa x DT fields and correcting adding and updating comments.

Corrections on Mapping Maarifa x DT fields (tags and milestones).

cairocoder01 · 2024-10-02T11:57:40Z

@adventureit Nice work getting this started. I tested the first endpoint and found a number of problems, so I didn't test the others yet since they will probably have the same ones. Once the bugs below are fixed, I can test the other 2 endpoints and look at the code in more detail.

Simple Contact

When sending to POST /wp-json/dt-maarifa/v1/contacts

{
    "id": 12345,
    "name": "John Doe",
    "email": "john.doe@test.com",
    "phone": "+1-9995551234",
    "street": "South Pole",
    "country": "antarctica",
    "gender": "male",
    "age": "35-44",
    "notes": "General info about contact"
}

I get the error:

{
    "code": "create_post",
    "message": "'notes' field expected to be an array",
    "data": null
}

When sending to POST /wp-json/dt-maarifa/v1/contacts
with simple data above (without notes property)

I get the error:

{
    "code": "update_multi_select_fields",
    "message": "missing values field on: milestones",
    "data": {
        "status": 400
    }
}

However, it does create a contact and will succeed on the second try.

After the second try, I noticed these bugs:

the contact does not have the street/country values in the Locations or Address fields
the maarifa_data field is set to the id but should be the whole contact json object (this will cause the Maarifa tile on the contact screen to show the id and other info)
the contact should have a source of 'maarifa' added
the age field is not being set

Full

When sending to POST /wp-json/dt-maarifa/v1/contacts

{
    "id": 45235,
    "name": "Jon Doe \/ Bob Johnson",
    "email": "[\"bobscott.explorer@gmail.com\",\"test@gmail.com\"]",
    "phone": "[\"+44-1234567890\",\"+1-9995551235\"]",
    "phonecode": "+44",
    "skype": "",
    "facebook": "",
    "street": "South Pole",
    "country": "antarctica",
    "ip_city": null,
    "ip_city_id": null,
    "gender": "male",
    "age": "45+",
    "background": "christian",
    "spiritual": "seeker",
    "tags": [{
        "id": 11,
        "name": "\u0623\u062d\u0644\u0627\u0645 \u0631\u0648\u062d\u064a\u0629",
        "alias": "spiritual-dreams"
    }, {
        "id": 19,
        "name": "\u0627\u0628\u0646 \u0627\u0644\u0633\u0644\u0627\u0645",
        "alias": "person-of-peace"
    }],
    "notes": "testest",
    "created": 1602661663,
    "last_updated": 1710502175,
    "last_seen": 1710502175,
    "first_contact": "whatsapp",
    "first_contact_details": null,
    "first_source": "-",
    "ds_user_id": "",
    "external_id": "20",
    "external_url": "https:\/\/maarifa.journey.tools\/demo",
    "location_details": null,
    "milestones": {
        "has bible": true,
        "studying": true,
        "profession": false,
        "can share": false,
        "sharing": false,
        "baptized": false,
        "baptizing": false,
        "in group": false,
        "starting groups": false
    }
}

I am noticing these bugs:

phone numbers are not split
emails are not split
location not set
age not set
Missing source of Maarifa
maarifa_data set to id instead of full object
Notes fails with message about needing to be an array. Removed that property to test the above.

Code Formatting

You might notice that on this pull request, there is a notice that checks failed. If you click into that, you should be able to see that the PHPCS (PHP code sniffer) - which makes sure the code is formatted in a consistent way - is failing. You can run that check locally by using these commands on your command line:

composer install
composer run lint
composer run lintfix

The third one will try to automatically fix whatever it's able to. Mostly it fixes spacing of the code. The second will tell you exactly what other issues there are. Let me know if any of them are hard to understand.

Correcting bugs

Fixing bugs: -maarifa_data field -age field -phone numbers are not split -emails are not split -age not set -maarifa_data set to id instead of full object -Notes fails -Code Formatting

adventureit · 2024-11-05T15:15:37Z

Hi, Jon. Thanks for your review and support.
Bugs fixed, except location (still working on it) and source = maarifa. I do not have Maarifa as an option on my sources list. Should i have it or need do add it somehow?

Thank you.

Fixing location.

Adding source = maarifa

cairocoder01

@adventureit This is working much better now! Nicely done! Adding a contact seems to work great and updating contacts also seems to work well. I wasn't able to add an interaction/comment, but I'm guessing you haven't worked much on that part yet.

I left a few code comments of some things that can be cleaned and a few bugs.

rest-api/rest-api.php

cairocoder01 · 2025-01-08T21:06:17Z

rest-api/rest-api.php

+        if ( !empty( $contact_map['tags'] ) )
+            {
+
+            $int_count0 = 0;
+
+            foreach ( $contact_map['tags'] as $key => $value ) {
+
+                $fields_map['tags']['values'][$int_count0]['value'] = $contact_map['tags'][$key]['alias'];
+
+                $int_count0++;
+
+            }
+        }


This works, but there's two things that could clean it up:

I don't think you need the int_count0 variable. You can just assign to $fields_map['tags']['values'][] = [ 'value' => $value['alias']. That [] means to append a new item to the array.

In that code above, you'll see that I used $value instead of $contact_map['tags'][$key] since it should be the same thing from how you wrote the foreach statement. You get the key and the value, so you can just directly use the value.

It looks like this suggestion hasn't been changed yet.

Something happened in my last commit and I lost the changes. I redid tit and just made a new commit.

cairocoder01 · 2025-01-08T21:08:36Z

rest-api/rest-api.php

+
+        if ( !empty( $contact_map['milestones'] ) ) {
+
+            $int_count = 0;


See comment above about not needing the int_count. You can just write [] to append a new item to an array.

It looks like this suggestion hasn't been changed yet.

Something happened in my last commit and I lost the changes. I redid tit and just made a new commit.

rest-api/rest-api.php

Fixing bugs in location (country), interactions, update (returning post), and adding comment.

cairocoder01

Almost there. I just noticed a bug that if you don't send a milestones property in the API body when doing an update, you get an activity message in the DT UI that says "0 added to Faith Milestones"

cairocoder01 · 2025-02-06T10:16:14Z

rest-api/rest-api.php

+        if ( !empty( $contact_map['tags'] ) )
+            {
+
+            $int_count0 = 0;
+
+            foreach ( $contact_map['tags'] as $key => $value ) {
+
+                $fields_map['tags']['values'][$int_count0]['value'] = $contact_map['tags'][$key]['alias'];
+
+                $int_count0++;
+
+            }
+        }


It looks like this suggestion hasn't been changed yet.

cairocoder01 · 2025-02-06T10:16:44Z

rest-api/rest-api.php

+
+        if ( !empty( $contact_map['milestones'] ) ) {
+
+            $int_count = 0;


It looks like this suggestion hasn't been changed yet.

cairocoder01 · 2025-02-06T10:18:17Z

rest-api/rest-api.php

+        }
+        else //No milestones
+            {
+            $fields_map['milestones']['values'][1]['value'] = 0;


What is the intention with this code? I noticed that if I didn't send the milestones property in the API request, the activity comment in DT said "0 added to Faith Milestones".

adventureit added 5 commits August 21, 2024 17:57

[DT-M3] Create dt-maarifa API to receive contact and interaction data…

53ab475

… - Maping Maarifa x DT fields Creating function mapFieldsToContact to map Maarifa x DT Fields and contemplate differences and exceptions.

[DT-M3] Create dt-maarifa API to receive contact and interaction data

280d0d7

Mapping Maarifa x DT fields and correcting adding and updating comments.

[DT-M3] Create dt-maarifa API to receive contact and interaction data

d0fa663

Corrections on Mapping Maarifa x DT fields (tags and milestones).

Merge branch 'master' of https://github.com/adventureit/dt-maarifa

1e45c0c

cairocoder01 self-assigned this Oct 2, 2024

adventureit added 3 commits October 9, 2024 13:08

[DT-M3] Create dt-maarifa API to receive contact and interaction data

dcb291a

Correcting bugs

phpcs

87fd680

[DT-M3] Create dt-maarifa API to receive contact and interaction data

728020e

Fixing bugs: -maarifa_data field -age field -phone numbers are not split -emails are not split -age not set -maarifa_data set to id instead of full object -Notes fails -Code Formatting

adventureit and others added 5 commits November 19, 2024 15:31

[DT-M3] Create dt-maarifa API to receive contact and interaction data

9d26000

Fixing location.

fix maarifa source

04a7665

Merge branch 'master' of https://github.com/adventureit/dt-maarifa

976fad0

[DT-M3] Create dt-maarifa API to receive contact and interaction data

3ba92cc

Adding source = maarifa

[DT-M3] Create dt-maarifa API to receive contact and interaction data

c579ee3

Adding source = maarifa

cairocoder01 requested changes Jan 8, 2025

View reviewed changes

[DT-M3] Create dt-maarifa API to receive contact and interaction data

bd76276

Fixing bugs in location (country), interactions, update (returning post), and adding comment.

cairocoder01 requested changes Feb 6, 2025

View reviewed changes

cairocoder01 added 2 commits February 6, 2025 13:30

remove unused file

8d520dc

Merge branch 'master' into adventureit-master

1b16ee6

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DT-M3] Create dt-maarifa API to receive contact and interaction data #2

[DT-M3] Create dt-maarifa API to receive contact and interaction data #2

adventureit commented Sep 26, 2024

cairocoder01 commented Oct 2, 2024 •

edited by adventureit

Loading

adventureit commented Nov 5, 2024

cairocoder01 left a comment

cairocoder01 Jan 8, 2025

cairocoder01 Feb 6, 2025

adventureit Feb 25, 2025

cairocoder01 Jan 8, 2025

cairocoder01 Feb 6, 2025

adventureit Feb 25, 2025

cairocoder01 left a comment

cairocoder01 Feb 6, 2025

cairocoder01 Feb 6, 2025

cairocoder01 Feb 6, 2025


		if ( !empty( $contact_map['milestones'] ) ) {

		$int_count = 0;

[DT-M3] Create dt-maarifa API to receive contact and interaction data #2

Are you sure you want to change the base?

[DT-M3] Create dt-maarifa API to receive contact and interaction data #2

Conversation

adventureit commented Sep 26, 2024

cairocoder01 commented Oct 2, 2024 • edited by adventureit Loading

Simple Contact

Full

Code Formatting

adventureit commented Nov 5, 2024

cairocoder01 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cairocoder01 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cairocoder01 commented Oct 2, 2024 •

edited by adventureit

Loading