Efficy Overflow Q&A - Recent questions tagged api

Timeout when importing Woocommerce data from Productvariations Table

Fri, 20 Oct 2023 13:19:02 +0000

Hi,
I'm trying to get data from a Woocommerce website and the process with the Efficy datasynchro tool doesn't ends.
I'm using a specific ODBC (Cdata driver) driver to access to the Woocommerce database.
Question :
Is there any parameters for this kind of processes ?
Thank you Dimitri

Edit specific detail from SOAP API when K_RELATION exists

Wed, 15 Mar 2023 13:53:11 +0000

when using the soap interface, the customer wants to update a detail (contact) on a relation where K_RELATION is present.

This is his request

<SOAP-ENV:Envelope xmlns:efficy=http://www.efficy.com xmlns:SOAP-ENV=http://schemas.xmlsoap.org/soap/envelope>
            <SOAP-ENV:Body>
                           <efficy:edit key="734871" entity="POLI">
                                           <updatedetail detailkey="27963" detail="CONT">
                                                           <f_role>2</f_role>
                                           </updatedetail>
                           </efficy:edit>
            </SOAP-ENV:Body>

and this the response :

<SOAP-ENV:Envelope xmlns:efficy=http://www.efficy.com xmlns:SOAP-ENV=http://schemas.xmlsoap.org/soap/envelope>
<SOAP-ENV:Body>
    <efficy:edit key="734871" entity="POLI" edithandle="4" error="true">
        <updatedetail detailkey="27963" detail="CONT">
            <f_role>2</f_role>
        </updatedetail>
    </efficy:edit>
    <SOAP-ENV:Fault>
        <faultcode>EEfficyException</faultcode>
        <faultstring>Cannot find detail with key "27963", relation "1"</faultstring>
        <faultid/>
        <Detail>CORE-1332</Detail>
    </SOAP-ENV:Fault>
</SOAP-ENV:Body>

does he need to search for the specific detail with the detail or is there a better way to obtain the K_RELATION to edit the correct detail ?

SOAP API Security

Wed, 22 Feb 2023 10:53:13 +0000

Good morning everyone,

I'm testing the configuration of the SOAP API and I'm a bit confused on how the security works.

Following the "Easy SOAP integration" project guide I created two queries : one to retrieve a contact's Key with a email parameter and another to retrieve the list of active opportunities of a specific department (no parameter, the department is set). Both query have the following security settings : Administrators group : full control.

I've setup the SOAP Group removing any Privileges and any Table Rights, only checking Query:Execute.
I've setup the SOAP User removing any User Privileges and any User Privileges in Designer ; setting the User Role as SOAP Group; removing the user from Everyone and adding it to the SOAP Group.

Testing the API calls with Postman I get the following results :
* the contact query returns the key value
* the opportunities query return no results unless I add the SOAP User to the right department group

Where does the different behaviour come from ?
Subsequently, how can I restrict the SOAP user from executing any request, allowing only the few specifically designed for the API purpose ?

Thank you for your help,

Alexandre

how open a soap session by using api token rather than efficy:logon xml tag ?

Thu, 24 Nov 2022 08:13:25 +0000

Hello I want to use the advantages of the API token authentification into à soap request rather than using the old body xml tag for a migration from 11.0 to 12.0 version.

So I generated a token into my designer, then I added into the header the
X-Efficy-ApiKey, X-Efficy-Customer and X-Efficy-Logoff = true like I already done for node connexion for instance.

The customer profile is unique into my url so didn't declare it.

Bug I'm not able to create the connexion to execute a soap query resquest.

So I have to continue to put all information
Any idea ?
What I missed ?

have you any postman exemple with a body using datacontainer operation="query" + connexion via token ?

Thank's
Laurent Tuffraud

(API) How to send fax and sms from Efficy as it exists for emails notifications ?

Thu, 10 Nov 2022 10:26:34 +0000

Hello,

Is there any API for sending sms and/or faxes from Efficy ?

Thank you
Dimitri

Is there a way to send mutlivalue fields values through the API ?

Wed, 05 Oct 2022 16:01:01 +0000

We try to use the API to call an Efficy Query that contains multivalue fields.

When we execute the query in Efficy, the result contains the value of the multivalue field, but when we execute the query through the API, the multivalue field is getting the key separated by semic-columns.

In order to test it in a standard Efficy 12.0 Efficy Entreprise, it is quite easy :

1- create an API key in Efficy Designer (link to admin user)
2- create an Efficy Query for instance :
[Select]
OPPORTUNITIES.K_OPPORTUNITY
OPPORTUNITIES.NAME
OPPORTUNITIES.COMPETITORS

[From]
OPPORTUNITIES

[Where]
OPPORTUNITIES.COMPETITORS notisnull ""

[Orderby]

[Options]
ChangeParameters=0
Distinct=0

[InlineEdit]

3- Call this query from Postman :

URL : http://{{YOUR_LOCAL_EFFICY}}/crm/json

HEADERS
X-Efficy-ApiKey:{{EfficyAPIKey}}
Cache-Control:no-cache
Content-Type:application/json
Accept:application/json
Cookie:{{EfficyCookie}}
X-Efficy-Logoff:False
X-Efficy-Lang:FR

BODY
[
{
"@name": "api",
"@func": [
{
"@name": "query",
"key": "{{Efficy Query KEY}}"
}
]
}
]

Result of the API :

{
    "K_OPPORTUNITY": 30,
    "NAME": "test",
    "COMPETITORS": ";1;2;"
},

Result in Efficy :

Attended Result from the API :

{
    "K_OPPORTUNITY": 30,
    "NAME": "test",
    "COMPETITORS": "Competitor1, Competitor2"
},

PS: I Tried with the Alias "MULTIVALUE" but that did not change a thing.

How to manage SOAP requests WSSE (open spec) authentication in JS ?

Tue, 04 Oct 2022 14:16:14 +0000

Hello,

Some context: I have a customer who want me to query the KBO OpenData API.
They use SOAP along with the WSSE open standard, for the authentication.

Do we have a library / tool / projutil to handle the generation of a WSSE header (given a password and username) ?

I swear I have looked around, but alas didn't find such tool

Thank you

Efficy Entreprise Remote API and Sessions : does the SS_ID is working with the JSON API and the API Key ?

Wed, 05 Jan 2022 15:32:12 +0000

On EDN efficysessionclass it is written that we can use the SS_ID parameter in order to create has many sessions we want with the SOAP api.

I suppose it works, but does this SS_ID parameter is working with the JSON API?
I also suppose that it works, but does this SS_ID parameter is working when we use an Efficy API KEY?
Do we have any limitation of the number of sessions that we can open/managed?
Do we have to manage a cookie for each session we open with the SS_ID?
I suppose we need to do it, but do we have to close each sessions once all the calls are finished?
If we don't use the SS_ID parameter is it possible to launch several Efficy API calls at the same time? if yes, how many simultaneous call can we do?

I know it is a lot of question, but I could not find any answer in EDN.

disableSecurity inefficient when called via node request

Wed, 03 Mar 2021 16:34:51 +0000

When some code called via a node request tries do disable the security,
it's INEFFICIENT ! (Efficy 11.2)
I implemented a minimum node file to demonstrate it, where I try to open an edit context on a record for which the user linked to the API key has no right:

function main() {
    Efficy.disableSecurity = true;
    try {
        try {
            var editHandle = Efficy.openEditContext(ntDocu, 828855);
            try {
                Response.setContent("I did open my record!");
                Response.setStatusCode(200); // HTTP_OK
            }
            finally {
                Efficy.closeContext(editHandle);
            }
        } catch (e) {
            Response.setStatusCode(400); // HTTP_BADREQUEST
            Response.setContent("Efficy.disableSecurity = " + Efficy.disableSecurity + " but...\n" + e.message);
        }
    }
    finally {
        Efficy.disableSecurity = false;
    }
};

And the response is :
This works as designed or did I miss something?
This is the same of each Efficy property?

Config when using json/node api in loadbalencer environnement

Thu, 03 Dec 2020 08:48:55 +0000

Hi all,

For a customer, we will need to use json/api node.
Customer have actually an environnement with 2 "frontend" serveur behind a loadbalencer, and 1"webservice" serveur for soap call.

Should we use the same infrastrucure and make json/node api call to the webservice serveur to avoid session problem ?
Or is there something better to do ?

regards,

Is it possible to filter by null values using "consultmanyex" function (JSON API) ?

Mon, 02 Mar 2020 07:08:22 +0000

I'm using the JSON API to call the "consultmanyex" function and search for an entity that meet a certain predicate.

I would like to base my predicate on the existence of a value for a certain field.

Do you have an idea of how I can specify a "Null" value in my predicate ?

Here is a query example (that obviously does not work) of what I'm trying to achieve :

[{
    "@name": "api",
    "commit": true,
    "closecontext": true,
    "@func": [
        {
            "@name": "consultmanyex",
            "entity": "ContComp",
            "findfield": "k_contact;d_end",
            "keys": "3544;NULL",
            "separator": ";"
        }
    ]
}]

[Remote API - Javascript] Problem with the CORS policy

Wed, 27 Nov 2019 14:28:51 +0000

Hello ereryone,
I created an Efficy query to retrieve active events or profiles. They must be processed in an external HTML page. The event reception tests are conclusive in the Postman software.

Unfortunately in Javascript, I receive the following message:
Access to XMLHttpRequest at 'https://labcrm.brrc.be/crm/json' from origin 'http://cms_test.brrc.be' has been blocked by CORS policy: Response to preflight request doesn't pass access control check: No 'Access-Control-Allow-Origin' header is present on the requested resource.

Here the Javascript code:

const uri = 'https://xxxx.brrc.be/crm/json';
var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://xxxx.brrc.be/crm/json",
  "method": "POST",
  "headers": {
"Access-Control-Allow-Origin": '*',
"Access-Control-Allow-Credentials": 'true',
    "X-Efficy-Customer": "CRR",
    "X-Efficy-ApiKey": "",
"X-Efficy-Logoff": "false",
"X-Efficy-Lang": "EN",
"Cache-Control": "no-cache",
    "X_CLIENT_APP": "CRR",
"Content-Type": "application/json",
"Accept": "application/json"
  },
  "processData": false,
  "data": "[\r\n\t{\r\n\t\t\"@name\": \"api\",\r\n\t\t\"@func\": [\r\n\t\t\t{\r\n\t\t\t\t\"@name\":\"query\",\r\n\t\t\t\t\"key\":\"4102\"\r\n\t\t\t}\r\n\t\t]\r\n\t}\r\n]"
}
$.ajax(settings).done(function (response) {
  console.log(response);
});

Still, I added the following headers:

"Access-Control-Allow-Origin": 'http://xxxx.brrc.be' or '*',
"Access-Control-Allow-Credentials": 'true'

From what I understand, these instructions are placed server side so I do not understand what I have to write.

Would you have an idea for me?
In advance, I thank you.
Best regards,
Bruno

OAuth2.0: Connection from serverside script

Tue, 19 Nov 2019 10:02:24 +0000

Hello,

for the integration of Rydoo, I need to use a specific authentication protocol called "OAuth2.0". I need to make the API call server-side but to retrieve the authentication token from the API they need this "side-call". It has to be provided as extra in the call, not in the header, body or in the URL params.

I managed to use the API via Postman, but it doesn't seem like there is a way in efficy to make this kind of call (or at least I couldn't find any documentation for it).

Here are some screenshots if it helps to explain my current problem.

How to use Remote Api when sso is activated

Mon, 14 Oct 2019 09:29:37 +0000

Hi All,

I have made an listle custom using /json and /node api.
Working good on the customer test server, but not in their prod server because sso is activated.

(receive a 401 access denied, exactly like you click cancel on the pop windows when trying to connect with a browser)

what do i need to do ?
sending "something" in the header of the request for sso ?
configuring "something" on the server to don't use sso for the remote api ?
other ?

Regards.

Remote Api node is working but return an error in header

Fri, 11 Oct 2019 11:08:18 +0000

Hi Everyone,

I've made a short node api for a customer.
When he use it, all is working good, but he receive this in the header of the response.

X-Efficy-Status:
  - error

i've try locally on my computer with postman and i didn't have this.
I've not yet try on customer test server with postman to see if we have this also

Do you know in which case this is returned in the headers ?

Regards,

Download CONTACTS.PICTURE using api

Mon, 12 Aug 2019 13:24:51 +0000

Is it possible to download pictures from for example contacts.picture using a json API request? I cannot find any documentation about this.

How can I generate .PDF from .DOCX attachment in workflow?

Mon, 12 Aug 2019 12:05:12 +0000

We want a related .PDF attachment for each .DOCX template generated invoice.
Can we do this in workflow/serverscript?

API calls to a test environment reflects request body?

Tue, 26 Mar 2019 11:07:21 +0000

Hi,

I've been trying to use the json api on a test environment. Every time I send a request, it just reflects the json body I sent back to me instead of the data I request.

I use this url: {testenvironment}/crm/json

These are the request headers:

These are the response headers:

I have a feeling I'm missing something obvious.

OpenUrlSecure How can I get the response body when not success

Tue, 11 Dec 2018 10:59:58 +0000

Hi,

apparently, the response.body of a openUrlSecure call is empty when the success != true.
is that a feature or an anomaly?

It seems that the body is well filled when success = true;

point is the api i am requesting send me an error message in the body (checked it with postman)

Do I have a way to workaround this?

Locate on map from company edit not working

Tue, 03 Jul 2018 14:57:20 +0000

Hello,

I've been trying to test on Efficy 11 r12921 the "Locate on Map" button on company edit window, ofcourse first issue i had was that the api key was not retrieved from MacroDialog.GoogleMapsApiKey because it's not loaded probably in edit context, so i add the API key in MacroEditCustom

JsonEditModelCustom.Comp {[
    ,"googleMapsApiKey": "BRloSyBlppcrlzp_RxxQWpN8PTKmU1HQNIXyUo"
]}

second i got the error as below, and i can't get what is the problem exactely

So is it a bug or am i missing something? i checked on submariners, and it's the same issue.

Thank you in-advance for your help and advice.

Best Regards.

Email polling and automatic ticket creation based on keywords in subject.

Tue, 13 Jun 2017 12:17:52 +0000

Hi everyone!

For a customer, I need to make a estimate (if what they ask is possible) for an Efficy module cappable of:

polling from a specific mailbox on the incoming email customer requests
Scanning the emails in the subject and contents for specific keywords, e.g. “Kündigung” (cancellation)
Automatically create tickets (cases) in Efficy with predefined categories and contents (similar output from the Profiler request to Efficy) based on the found keywords in step 2) and direct the cases to the specific team ticket folder based on the corresponding business rules.
If documents or emails are attached in the ticket, these attachments should be stored in a fileshare or sharepoint, not in the Efficy database.
If a user uploads emails or documents or attachments into Efficy via the Efficy Outlook Plugin, these attachments should be stored in a fileshare or sharepoint, not in the Efficy database.

Do someone have some idea on how it could be done?
Is it worth it to develop that kind of App/Module?

KR,

Prince.

Google Geocoding via scheduled workflow

Wed, 31 May 2017 12:52:00 +0000

Hi all,

is there already a solution available to do geocoding in (scheduled) workflow?

Thank you

Tim

Google Maps in search results: No API key

Mon, 05 Sep 2016 12:20:08 +0000

Hi everyone,

We are getting an error when trying to use the "Display on Google Maps" feature of the search result screen (Efficy Build 10.0.7987).
It is stated that the service requires an API key and that we don't provide any.

Is there something to configure to use that feature?

Laurent

API information

Tue, 20 Oct 2015 11:40:44 +0000

Some questions:
1. Do we have an API (for Efficy 2014) for third party software?
2. Is there documentation?

We need this, because one of my clients wants to talk to Efficy through an API.

Please respond soon.

Handling inbound calls from a telephone system through API

Wed, 01 Jul 2015 13:50:52 +0000

Hi,

has someone already made something to handle inbound calls from a telephone system through an API?
We have a customer which has a telephone system which has a TAPI-driver, but this handles only the outbound calls and not the inbound calls. So if someone has done this already then we would like to know how this has been done.

Best regards,
Jeroen