Perfion API Perfion Data Access Guide
Give your websites, apps and business systems direct, signed-in access to Perfion: they ask for exactly the product data they need, fetch images and datasheets on request, and every query can be tested before it goes live.
The Perfion API is how other systems read Perfion directly instead of waiting for an exported file. A caller signs in with a bearer token, asks with a Perfion Query through the REST data endpoint or the Data Web Service, and gets back structured data in which each image or file appears as a binary ID. Reports, Actions and audit logs are reached through the same service, and the API Query Builder lets a query be tested in the Web Client first.
At a glance
- Perfion name
- REST endpoint, Data Web Service and Report Service
- Where
- In the Perfion API service, through the REST endpoint and the Data Web Service; queries tested in the Web ClientRESTWeb ServiceQuery BuilderREST calls always sign in as a Perfion user
- Used by
- Integration teams, developers and Perfion administratorsThe Query Builder needs the required permissions
- Works with
- ReportsActionsE-commerce API
- Report formats on request
- 9 output formats for reports requested through the APIPPDFHHTMLMMHTRRTFXXLSXXLSXCCSVTTextAAddInOutput
How systems use the Perfion API, from a sign-in to a checked answer
A system signs in, asks with a query, gets a structured answer, and fetches files and reports when it needs them; every query can be tested first and every sign-in traced.
Sign in
The calling system signs in as a Perfion user and receives a bearer token, issued by the Perfion API or, from version 5.0, by Azure AD.
Ask with a query
A Perfion Query names the features, items and languages wanted. It goes to the REST data endpoint or the Data Web Service, or a saved search is called by its reference.
Get a structured answer
Perfion answers in JSON or XML, with multi-valued, sequenced and localised data. Images and files come back as a binary ID each.
Fetch files and reports
The File & Image Server delivers the images and files, and the Report Service returns a report for chosen items, in the chosen language and format.
Test and trace
The API Query Builder tests a query before systems rely on it, and audit logs show who signed in, when, and through which interface.
Exported files vs Perfion API: what changes when systems ask Perfion directly
Exported files carry product data to other systems as copies: whole sheets, sent on a schedule, to whoever has the login. The Perfion API lets each system ask Perfion for exactly what it needs, signed in, when it needs it.
| Task | Exported files | Perfion API |
|---|---|---|
| Getting data out | Exported to a file and emailed. | Asked of Perfion when it is needed, through the Perfion API. |
| Choosing the data | The whole sheet sent; the receiver picks columns. | A Perfion Query names the features, items and languages. |
| Languages | One file per language. | Localised values in several languages, in one answer. |
| Images and files | Zipped and sent separately. | Referenced by binary ID, fetched when needed. |
| Datasheets | Made and attached by hand. | Generated on request by the Report Service. |
| Shared selections | Rebuilt in every system. | Kept in Perfion as a saved search, called by reference. |
| Access | One shared login, files forwarded. | Signed-in calls with a bearer token that expires. |
| Who read what | Nobody knows. | Audit logs by user, time and interface. |
See how your own systems would read Perfion directly.
See it for your business →Perfion API capabilities: eight ways other systems use the product record
Each capability shows what it does in Perfion, and what it is worth to the business.
Operational Reality (Capabilities)
All data in Perfion can be queried through the Perfion API, using the Perfion Query. A query is written in sections, Select, From, Where, Having and Order, with a syntax inspired by SQL so that it is easy to learn. Unlike a plain SQL table, the answer can hold multi-valued and sequenced data and localised values in several languages, along with other abilities a flat tabular result cannot give. The same queries are used inside Perfion for testing views, filters and the E-commerce API, for setting up dashboards and for working with search features.
- Select, From, Where, Having, Order
- Multi-valued and sequenced data
- Several languages in one answer
Executive ROI Value
Each system gets the features, items and languages it needs in one call, instead of a whole export to sort through.
- Exact data
- Every language
Operational Reality (Capabilities)
The REST data endpoint takes a Perfion Query in JSON and answers in JSON. The Data Web Service has a single query method that takes a Perfion Query in XML or JSON and answers in XML. Both return images and files as references, not as the files themselves. The REST endpoint accepts bearer tokens only; the web service accepts a username and password or a bearer token. Both can report the version of the Perfion API, and the REST endpoint answers with standard response codes for success, a bad request, a missing or invalid token, and a server error.
- REST: JSON in, JSON out
- Web service: XML or JSON in, XML out
- Standard response codes
Executive ROI Value
New apps and older systems alike connect to the same product record, in the format they already handle.
- Any system
- One record
Operational Reality (Capabilities)
Besides a query sent in full, the REST endpoint can run a Perfion Query saved on an item of a search feature: the calling system sends only the reference of that saved search. Two optional values add paging to the saved query, a page index and a maximum count per page, so a large result can be fetched a page at a time. The answer has the same format as for a query sent in full.
- Query saved in Perfion
- Called by its reference
- Page index and page size
Executive ROI Value
The query that feeds a website or an app is kept in Perfion, where the product team can see and test it, not hidden in another system.
- Visible
- Paged
Operational Reality (Capabilities)
Calls to the REST endpoints are always authenticated, and calls to the web service are when authentication is enabled at installation. A bearer token is sent with each call: Perfion issues one for a valid Perfion username and password, which travels as a one-way hash rather than in clear text, and from version 5.0 the API also accepts tokens issued by Azure AD, matched to the Perfion user by email. Perfion’s own tokens expire after 10 hours by default. An administrator can also issue a token for a user from the Windows client, valid for 1 day to 10 years; Boyum advises keeping that lifetime as short as possible. From 2024-R2 the signing key can be regenerated, which makes every existing token invalid. The audit logs endpoint returns events such as logins for a date range, with the user, time, interface and source, to callers that are signed in and hold the required role.
- Tokens from Perfion or Azure AD
- 10-hour default lifetime
- Audit events by date range
Executive ROI Value
Every system that reads product data is known, its access runs out on time, and its sign-ins can be reviewed.
- Known callers
- Reviewable
Operational Reality (Capabilities)
For binary features such as images and files, the API returns a binary ID, a reference to the file, rather than the file itself. The actual image or file is then fetched from the File & Image Server, which is included in the Perfion API service. For showing several images side by side, the web service can also work out one resolution that fits each image within a given width and height while keeping the images in proportion to one another.
- Binary IDs in every answer
- Files from the File & Image Server
- Images scaled in proportion
Executive ROI Value
Product answers stay light, and images shown together look right beside each other.
- Lighter answers
- Even images
Operational Reality (Capabilities)
A system can ask the API to process a Perfion report for one or more items and receive the finished file. Available from Perfion 2023 R1 SR1, the request names the report and the items, and can set the language, the output format and the report’s parameters, as defined in its SuperQuery. The formats are PDF, HTML, MHT, RTF, XLS, XLSX, CSV, Text and AddInOutput. The Report Service offers the same through a web address; it runs on a Microsoft IIS web server and is designed on a pull strategy so that it scales linearly.
- Nine output formats
- Language and parameters per request
- Several items in one report
Executive ROI Value
A dealer app, a quotation tool or a website gets a current datasheet the moment it asks, in the buyer’s language.
- Always current
- On request
Operational Reality (Capabilities)
The Execute Action endpoint starts a Perfion Action from outside Perfion. The calling system can pass input to the Action as one or more tables of values, and receives an execution queue ID in return. Like every REST endpoint, the call must carry a valid bearer token.
- Any Action, started by a call
- Input passed as tables
- Execution queue ID returned
Executive ROI Value
Work that already runs as an Action in Perfion can be started by the system where the need arises, without anyone logging in to start it.
- Automated
- On demand
Operational Reality (Capabilities)
Perfion API queries need in-depth knowledge of Perfion, so the API Query Builder makes basic querying easier while still letting advanced users write advanced queries. Users with the required permissions use it in the Web Client. Simple mode builds a query from Select, From and Where sections, with features, views, operators and languages picked from lists. Advanced mode is a text editor for XML or JSON with ready-made snippets. A query can be copied or tested: the results open read-only and can be saved in XML or JSON, and a query that updates, inserts or deletes items asks for confirmation before it runs.
- Simple and advanced modes
- Results tested before use
- Confirmation before changes
Executive ROI Value
Product and IT teams agree on exactly what a system will receive before anyone writes integration code.
- Tested
- Agreed
5 Core Concepts of the Perfion API
The first asks only for what a system needs and the second keeps the query in Perfion. The third makes every caller sign in for a limited time, the fourth sends files on demand, and the last tests queries and traces calls.
-
Concept 01 · The question decides the answer
Ask for Exactly What a System Needs
The product data problem it solves
The web agency receives a nightly export of all 6,500 items with 140 columns. Its developer keeps 30 of them, misses the Hindi descriptions entirely, and the website shows English text to every visitor.
The concept explained
The Perfion Query lets a system ask for exactly what it needs: which features, from which items, under which conditions, in which languages and in what order. Because the answer can hold multi-valued, sequenced and localised data, one query returns what a flat spreadsheet would need several files to carry. Asking narrowly keeps answers small and makes it clear, in one place, what each system receives.
Everyday analogy
Ordering from a menu, not taking the whole kitchen home. You name the dish; the kitchen sends that dish.
BPAS method · toolDeploy EnterpriseDesign before configurationThe data model is designed and signed off before anything is configured: the Design phase of toolDeploy Enterprise.In Perfion
The syntax is inspired by SQL, in Select, From, Where, Having and Order sections. Images and files come back as binary IDs, not as the files themselves.
The website asks for item number and name in English and Hindi, for pumps only; Perfion reads its one record and answers with 120 items. -
Concept 02 · Kept in Perfion, called by reference
Keep the Query in Perfion, Call It by Reference
The product data problem it solves
The dealer app and the website each carry their own copy of the active pumps query in their code. The product team retires a range; the website drops it, and the app keeps showing it for three months.
The concept explained
A query does not have to live inside the calling system. Saved on an item of a search feature, it can be run through the REST endpoint by its reference alone, and paging splits a large result into pages. The query then sits in Perfion, where the product team can see and test it, and every system that calls the same reference gets the same selection.
Everyday analogy
A standing instruction at the bank. Change it once at the bank, and every payment after follows it.
In Perfion
Two optional values, a page index and a maximum count, are added to the saved query on each call. The answer has the same format as for a query sent in full.
One saved search, two callers: the website and the dealer app call the same reference, a page at a time, and both pick up a change made once in Perfion. -
Concept 03 · Signed in, for a limited time
Every Caller Signs In, for a Limited Time
The product data problem it solves
The web agency, the app developer and an old quotation tool all use the same administrator login, saved in three places. When the developer leaves, nobody can change the password without breaking the website.
The concept explained
Every call to the REST endpoints is made as a Perfion user, and so is every call to the web service once authentication is enabled. The caller proves who it is with a bearer token, which Perfion issues for a valid username and password, or which Azure AD issues from version 5.0. Tokens expire: Perfion’s own after 10 hours by default, and a token an administrator issues from the Windows client after the lifetime chosen, which Boyum advises keeping as short as possible. When the signing key is regenerated, every existing token stops working at once.
Everyday analogy
A visitor badge at a factory gate. It names the visitor and is valid for the day; tomorrow needs a new one.
In Perfion
Passwords are sent as a one-way hash, never in clear text. Long-lived tokens, for instance in e-commerce connectors, must be updated after the signing key is regenerated.
Three calls: two with valid tokens are answered, one with an expired token is refused. Tokens come from Perfion, from Azure AD, or from an administrator. -
Concept 04 · References now, files when asked
Send Data First, Files on Demand
The product data problem it solves
A dealer app downloads every product image with every product list. On a slow connection in a small town, the catalogue takes minutes to open, and the dealer gives up.
The concept explained
The API keeps product data and heavy files apart. An answer carries a binary ID for each image or file, and the system fetches the file from the File & Image Server only when it needs to show or send it. Reports follow the same idea: the Report Service builds a datasheet for the chosen items, in the chosen language and format, at the moment a system asks for it.
Everyday analogy
A library catalogue card. It tells you where the book is; you fetch the book when you want to read it.
In Perfion
For images shown side by side, the web service can work out one resolution that fits each image in a given frame and keeps them in proportion. Report requests through the REST API are available from Perfion 2023 R1 SR1.
The answer carries binary IDs; the image comes from the File & Image Server and a PDF datasheet from the Report Service, each only when asked for. -
Concept 05 · Tried before use, recorded after
Test the Query, Then Trace the Calls
The product data problem it solves
A new query for the website is written straight into the site’s code. It filters on the wrong feature, and 400 discontinued pumps go live on a Saturday. On Monday nobody can say which system signed in, or when.
The concept explained
The API Query Builder lets a query be built, run and checked in the Web Client before any system depends on it: results open read-only and can be saved in XML or JSON, and a query that would update, insert or delete items asks for confirmation first. Once systems are live, the audit logs show who signed in, when, through which interface and from where.
Everyday analogy
A trial run before the first production batch, and a gate register after it.
From BPAS · prodRecord newsletterprodRecordKeeping the record straight.One product data practice every month, written in plain English for product data teams.In Perfion
Simple mode builds a query from lists; advanced mode edits it as XML or JSON, with snippets. Reading audit logs needs a signed-in caller with the required role configured in Perfion.
A query built in Simple mode and tested: 120 items in read-only results. After go-live, the audit log shows each sign-in through the Perfion API.
10 Best Practices for the Perfion API
Each practice says what a well-run API setup looks like and what it costs to ignore it. Designing integrations around your own systems and data is what BPAS consultants do.
-
01Give every integration its own service user, never a person’s login
The rule
Each system that calls the API signs in as a service user meant for systems, not as a member of staff.
Risk if ignored
Integrations that stop when a person leaves, passwords nobody dares change, and audit entries that cannot tell a person from a system.
Get it right with BPAS
Not sure this is in place for your integrations? Talk to a BPAS consultant.
Talk to BPAS -
02Keep token lifetimes as short as the job allows
The rule
Systems renew their tokens as they expire, and long-lived tokens are issued only where a system cannot, each with an owner and an end date.
Risk if ignored
A ten-year token in a forgotten system that still opens your product data.
Get it right with BPAS
Not sure this is in place for your integrations? Talk to a BPAS consultant.
Talk to BPAS -
03Keep passwords out of web addresses
The rule
Credentials never travel in a web address: tokens are requested in the way Boyum prefers, and passwords only ever as a hash.
Risk if ignored
Credentials left behind in caches along the way.
Get it right with BPAS
Not sure this is in place for your integrations? Talk to a BPAS consultant.
Talk to BPASRelated:Capability: Signed-in calls and an audit trailConcept 03
-
04Reach the API only over a secure address
The rule
The Perfion API is published on a secure HTTPS address for every system that calls it.
Risk if ignored
Tokens and product data exposed on the way between systems.
Get it right with BPAS
Not sure this is in place for your integrations? Talk to a BPAS consultant.
Talk to BPASRelated:Capability: Signed-in calls and an audit trailGuide 14: E-commerce Connectors
-
05Ask for only the features, items and languages each system needs
The rule
Every query names the features, items and languages its system actually uses, and nothing more.
Risk if ignored
Heavy answers, slow pages, and product data in systems that never needed it.
Get it right with BPAS
Not sure this is in place for your integrations? Talk to a BPAS consultant.
Talk to BPAS -
06Keep shared queries as saved searches in Perfion
The rule
Queries that feed websites and apps are saved in Perfion and called by reference, so the product team can see and change them in one place.
Risk if ignored
The same selection coded differently in each system, and ranges that disappear from one channel but not another.
Get it right with BPAS
Not sure this is in place for your integrations? Talk to a BPAS consultant.
Talk to BPAS -
07Fetch large results a page at a time
The rule
Large selections are read in pages of a set size, not in one call.
Risk if ignored
Calls that grow heavier with every new range, until the calling system struggles to keep up.
Get it right with BPAS
Not sure this is in place for your integrations? Talk to a BPAS consultant.
Talk to BPASRelated:Concept 02Capability: Saved searches, called by reference
-
08Generate datasheets on request instead of storing copies
The rule
Systems that hand out datasheets ask Perfion for them when they are needed, in the buyer’s language, rather than keeping PDFs of their own.
Risk if ignored
Old datasheets sent to customers long after the product changed.
Get it right with BPAS
Not sure this is in place for your integrations? Talk to a BPAS consultant.
Talk to BPAS -
09Test every query in the Query Builder before a system depends on it
The rule
New and changed queries are run in the API Query Builder, and their results checked by someone who knows the data, before they go live.
Risk if ignored
Wrong selections published to customers, and update queries run without anyone seeing what they would change.
Get it right with BPAS
Not sure this is in place for your integrations? Talk to a BPAS consultant.
Talk to BPAS -
10Keep a register of systems and tokens, and review the audit log
The rule
A named person keeps a list of every system that calls the API and the token it uses, and reviews the audit log for sign-ins nobody expected.
Risk if ignored
Unknown systems reading product data, and connectors that stop without warning when the signing key is regenerated.
Get it right with BPAS
Not sure this is in place for your integrations? Talk to a BPAS consultant.
Talk to BPASRelated:Concept 05Capability: Signed-in calls and an audit trail
Perfion API self-audit: how many are in place today?
Tick each of the ten practices above that your business already follows. Your score updates as you go.
Tick the practices that are in place.
Nothing you tick is stored or sent.
Illustrative scenario: an Indian pumps manufacturer, with product data sent around as files
A manufacturer of pumps and motors carries about 6,500 items and sells through dealers across India, with a website, a dealer app and a quotation tool used by its sales team. Product data is kept in Perfion, in English and Hindi.
The Operational Challenge
Every night, a spreadsheet of every item is exported and emailed to the web agency and the app developer, who each load the columns they want. The quotation tool has its own copy, refreshed when someone remembers. Hindi descriptions travel in a separate file that the app never picks up, and sales staff make datasheet PDFs by hand and attach them to quotes.
All three systems use the same administrator login, saved in three places, and nobody can say which system read what, or when.
- Nightly files emailed to each team
- Three copies, three versions
- Datasheets made by hand
- One shared login
The Financial Transformation
The website and the dealer app now read Perfion through the REST data endpoint. Each calls a saved search kept in Perfion, a page at a time, and gets English and Hindi in one answer, with images fetched by binary ID. The quotation tool asks the Report Service for a PDF datasheet in the dealer’s language when a quote is made.
Each system signs in as its own service user with a bearer token that expires, every new query is tested in the API Query Builder first, and the audit logs are reviewed every month.
- Systems read Perfion directly
- One saved search per channel
- Datasheets generated on request
- Every system signs in as itself
| Cost line | Before (per month) | After (per month) | Difference (per year) |
|---|---|---|---|
| Preparing and sending data exports | ₹ 80,000 | ₹ 15,000 | ₹ 7,80,000 |
| Making and sending datasheets by hand | ₹ 60,000 | ₹ 12,000 | ₹ 5,76,000 |
| Fixing data that differs between systems | ₹ 40,000 | ₹ 8,000 | ₹ 3,84,000 |
| Total | ₹ 1,80,000 | ₹ 35,000 | ₹ 17,40,000 |
See how your own systems would read Perfion directly.
Book a Perfion API review →prodRecord Live
Enterprise product data insights from BPAS
Keeping the record straight, live every month
prodRecord Live is a monthly webinar series on product information management, held on the second Wednesday of every month from January 2027. Each session takes one product data topic and works through it in plain English with time for your questions.
- Jan
- Feb
- Mar
- Apr
- May
- Jun
- Jul
- Aug
- Sep
- Oct
- Nov
- Dec
Who benefits when systems ask Perfion directly: one record, three answers
-
Promoter & CXOs
Can our website, dealer app and sales tools all show the same product data, without files being sent around?
Every system reads the one product record through the Perfion API, so customers, dealers and sales staff see the same, current data.
-
IT and Integration Lead
Can our systems read exactly the data they need from Perfion, in a format they already handle?
The REST data endpoint answers in JSON and the Data Web Service in XML; a Perfion Query or a saved search, tested first in the API Query Builder, decides what each system receives.
-
Perfion Administrator
Can I control who calls the API, and see what happened?
Callers sign in as Perfion users, a bearer token expires on time, and the audit logs show who signed in, when, and through which interface.
Perfion API Vocabulary and Definitions
From the Perfion API, the Perfion Query and its REST and web service endpoints to saved searches, bearer tokens, binary IDs, the File & Image Server, the Report Service and the API Query Builder. Each term shows what it means, why it matters, and a household comparison.
-
Perfion API
API · servicePerfion for other systems
Operational definition
The service that lets other systems work with Perfion: a REST endpoint and a web service for queries, plus endpoints for reports, Actions, the version and audit logs, and a File & Image Server.
Why it matters in Perfion
Websites, apps and business systems read the one product record directly.
Everyday analogy
A shop counter: customers ask, and the shopkeeper hands over what they asked for.
See it in action:How it works →
-
Perfion Query
API · languageAsk in sections
Operational definition
Perfion’s query language, inspired by SQL, written in Select, From, Where, Having and Order sections. It can return multi-valued, sequenced and localised data in several languages.
Why it matters in Perfion
Each system asks for exactly the features, items and languages it needs.
Everyday analogy
An order form: item, quantity, size and the language on the label.
See it in action:Concept 01 under Core Concepts →
-
REST data endpoint
API · JSONJSON in, JSON out
Operational definition
The Perfion API endpoint that takes a Perfion Query in JSON, or the reference of a saved search, and answers in JSON. It accepts bearer tokens only.
Why it matters in Perfion
Modern websites and apps connect in the format they already use.
Everyday analogy
A counter that takes written orders and hands back a packed box.
See it in action:Two ways in under Capabilities →
-
Data Web Service
API · XMLOne method, XML out
Operational definition
The Perfion API web service. Its single query method takes a Perfion Query in XML or JSON and answers in XML; it accepts a username and password or a bearer token.
Why it matters in Perfion
Systems built around XML read the same record as everything else.
Everyday analogy
A second counter at the same shop, for customers who prefer a different form.
See it in action:Two ways in under Capabilities →
-
Saved search
API · reuseA query called by reference
Operational definition
A Perfion Query saved on an item of a search feature. The REST endpoint runs it by its reference, a page at a time if needed.
Why it matters in Perfion
The query behind a channel is kept and changed in Perfion, in one place.
Everyday analogy
A standing instruction at the bank: change it once, and every payment follows.
See it in action:Concept 02 under Core Concepts →
-
Bearer token
API · accessProof of who is calling
Operational definition
A signed, time-limited token that proves who is calling the API. Issued by the Perfion API itself or, from version 5.0, by Azure AD. Perfion’s own expire after 10 hours by default.
Why it matters in Perfion
Every call is made by a known user, and access runs out on time.
Everyday analogy
A visitor badge: it names you, and it is valid for the day.
See it in action:Concept 03 under Core Concepts →
-
Binary ID
API · filesThe reference, not the file
Operational definition
The reference the API returns for an image or file instead of the file itself. The file is then fetched from the File & Image Server.
Why it matters in Perfion
Answers stay light; files come only when they are needed.
Everyday analogy
A cloakroom token: hand it over when you want your coat.
See it in action:Concept 04 under Core Concepts →
-
File & Image Server
API · filesWhere files come from
Operational definition
The part of the Perfion API service that delivers the actual images and files behind binary IDs.
Why it matters in Perfion
Images and files reach websites and apps straight from Perfion.
Everyday analogy
The cloakroom itself: the coats are kept here and handed out on request.
See it in action:Images and files by reference under Capabilities →
-
Report Service
API · reportsDatasheets on request
Operational definition
The Perfion API service that returns a Perfion report for chosen items, in a chosen language and format, such as PDF.
Why it matters in Perfion
Every datasheet handed out is current and in the right language.
Everyday analogy
A print shop that prints your leaflet fresh each time you ask.
See it in action:Reports generated on request under Capabilities →
-
API Query Builder
API · testingBuild it, test it
Operational definition
A Web Client tool for building and testing Perfion API queries: a simple mode for basic queries and an advanced mode for writing them in XML or JSON.
Why it matters in Perfion
A query is checked before any system depends on it.
Everyday analogy
A tasting spoon: try the dish before it goes out to the table.
See it in action:Concept 05 under Core Concepts →
Perfion API: questions integration teams ask
Short answers, each with a link to the part of this guide that explains it.
-
Query any data in Perfion, with a Perfion Query or a saved search; fetch images and files; generate a Perfion report for chosen items in a chosen language and format; start a Perfion Action with input data; read the version of the API; and, with the required role, read audit logs for a date range.
More on the Perfion Query -
Both query the same data. The REST endpoint takes a query in JSON, answers in JSON and accepts bearer tokens only. The Data Web Service takes a query in XML or JSON, answers in XML, and accepts a username and password or a bearer token. The choice usually follows what the calling system already handles.
More on the REST endpoint and web service -
As a Perfion user. For the REST endpoint, the system exchanges a valid username and password, sent as a one-way hash, for a bearer token, and sends that token with each call. Perfion’s own tokens expire after 10 hours by default. An administrator can also issue a token for a user from the Windows client, valid for 1 day to 10 years; Boyum advises keeping that lifetime as short as possible.
More on Concept 03 -
Yes, from version 5.0 of the Perfion API services, once the service is configured for it. Azure AD signs the user in and issues the token, and Perfion matches it to a Perfion user by email, so that user needs an email address in Perfion.
More on Vocabulary: Bearer token -
Yes. From Perfion 2023 R1 SR1, a system can ask the API to process a Perfion report for one or more items and receive the file, in a chosen language and in PDF, HTML, MHT, RTF, XLS, XLSX, CSV, Text or AddInOutput, with the report’s parameters if it has any. The Report Service offers the same through a web address.
More on Reports and Publishing -
The Perfion API has a general-purpose query language: the request says everything about the data wanted, and the answer comes in Perfion’s own structure. The E-commerce API is configured beforehand with channels, mappings and settings for commerce and web systems, so its requests need only a few parameters and its answers are closer to what those systems expect.
More on E-commerce API and Content Store -
Yes. The Perfion API works on Perfion’s own data, so this guide applies whichever ERP your business runs. Perfion’s ERP integration also reads product data through the Perfion API.
More on ERP integration
Still have a question?
Ask about your own products, categories and channels. A BPAS consultant will answer in plain English.
Ask BPASSee your systems reading Perfion directly
See how your own websites, apps and business systems would read product data from Perfion, signed in and asking only for what they need. Choose the path that fits the ERP you run.
The world's first Boyum Partner Center of Excellence.Hosted in the cloud and available for evaluation and proof-of-concept work across the Boyum Solutions portfolio.See it to believe it — get convinced by working on it.Explore the PACE sandbox→